reconnect moved files to git repo
This commit is contained in:
@ -0,0 +1,37 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._colorbar import ColorBar
|
||||
from ._contours import Contours
|
||||
from ._hoverlabel import Hoverlabel
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._line import Line
|
||||
from ._marker import Marker
|
||||
from ._stream import Stream
|
||||
from ._textfont import Textfont
|
||||
from ._xbins import XBins
|
||||
from ._ybins import YBins
|
||||
from . import colorbar
|
||||
from . import contours
|
||||
from . import hoverlabel
|
||||
from . import legendgrouptitle
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".colorbar", ".contours", ".hoverlabel", ".legendgrouptitle"],
|
||||
[
|
||||
"._colorbar.ColorBar",
|
||||
"._contours.Contours",
|
||||
"._hoverlabel.Hoverlabel",
|
||||
"._legendgrouptitle.Legendgrouptitle",
|
||||
"._line.Line",
|
||||
"._marker.Marker",
|
||||
"._stream.Stream",
|
||||
"._textfont.Textfont",
|
||||
"._xbins.XBins",
|
||||
"._ybins.YBins",
|
||||
],
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,436 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Contours(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.contours"
|
||||
_valid_props = {
|
||||
"coloring",
|
||||
"end",
|
||||
"labelfont",
|
||||
"labelformat",
|
||||
"operation",
|
||||
"showlabels",
|
||||
"showlines",
|
||||
"size",
|
||||
"start",
|
||||
"type",
|
||||
"value",
|
||||
}
|
||||
|
||||
@property
|
||||
def coloring(self):
|
||||
"""
|
||||
Determines the coloring method showing the contour values. If
|
||||
"fill", coloring is done evenly between each contour level If
|
||||
"heatmap", a heatmap gradient coloring is applied between each
|
||||
contour level. If "lines", coloring is done on the contour
|
||||
lines. If "none", no coloring is applied on this trace.
|
||||
|
||||
The 'coloring' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['fill', 'heatmap', 'lines', 'none']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["coloring"]
|
||||
|
||||
@coloring.setter
|
||||
def coloring(self, val):
|
||||
self["coloring"] = val
|
||||
|
||||
@property
|
||||
def end(self):
|
||||
"""
|
||||
Sets the end contour level value. Must be more than
|
||||
`contours.start`
|
||||
|
||||
The 'end' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["end"]
|
||||
|
||||
@end.setter
|
||||
def end(self, val):
|
||||
self["end"] = val
|
||||
|
||||
@property
|
||||
def labelfont(self):
|
||||
"""
|
||||
Sets the font used for labeling the contour levels. The default
|
||||
color comes from the lines, if shown. The default family and
|
||||
size come from `layout.font`.
|
||||
|
||||
The 'labelfont' property is an instance of Labelfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram2dcontour.contours.Labelfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Labelfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram2dcontour.contours.Labelfont
|
||||
"""
|
||||
return self["labelfont"]
|
||||
|
||||
@labelfont.setter
|
||||
def labelfont(self, val):
|
||||
self["labelfont"] = val
|
||||
|
||||
@property
|
||||
def labelformat(self):
|
||||
"""
|
||||
Sets the contour label formatting rule using d3 formatting
|
||||
mini-languages which are very similar to those in Python. For
|
||||
numbers, see:
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
||||
|
||||
The 'labelformat' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["labelformat"]
|
||||
|
||||
@labelformat.setter
|
||||
def labelformat(self, val):
|
||||
self["labelformat"] = val
|
||||
|
||||
@property
|
||||
def operation(self):
|
||||
"""
|
||||
Sets the constraint operation. "=" keeps regions equal to
|
||||
`value` "<" and "<=" keep regions less than `value` ">" and
|
||||
">=" keep regions greater than `value` "[]", "()", "[)", and
|
||||
"(]" keep regions inside `value[0]` to `value[1]` "][", ")(",
|
||||
"](", ")[" keep regions outside `value[0]` to value[1]` Open
|
||||
vs. closed intervals make no difference to constraint display,
|
||||
but all versions are allowed for consistency with filter
|
||||
transforms.
|
||||
|
||||
The 'operation' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][',
|
||||
')(', '](', ')[']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["operation"]
|
||||
|
||||
@operation.setter
|
||||
def operation(self, val):
|
||||
self["operation"] = val
|
||||
|
||||
@property
|
||||
def showlabels(self):
|
||||
"""
|
||||
Determines whether to label the contour lines with their
|
||||
values.
|
||||
|
||||
The 'showlabels' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showlabels"]
|
||||
|
||||
@showlabels.setter
|
||||
def showlabels(self, val):
|
||||
self["showlabels"] = val
|
||||
|
||||
@property
|
||||
def showlines(self):
|
||||
"""
|
||||
Determines whether or not the contour lines are drawn. Has an
|
||||
effect only if `contours.coloring` is set to "fill".
|
||||
|
||||
The 'showlines' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showlines"]
|
||||
|
||||
@showlines.setter
|
||||
def showlines(self, val):
|
||||
self["showlines"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
Sets the step between each contour level. Must be positive.
|
||||
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def start(self):
|
||||
"""
|
||||
Sets the starting contour level value. Must be less than
|
||||
`contours.end`
|
||||
|
||||
The 'start' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["start"]
|
||||
|
||||
@start.setter
|
||||
def start(self, val):
|
||||
self["start"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
"""
|
||||
If `levels`, the data is represented as a contour plot with
|
||||
multiple levels displayed. If `constraint`, the data is
|
||||
represented as constraints with the invalid region shaded as
|
||||
specified by the `operation` and `value` parameters.
|
||||
|
||||
The 'type' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['levels', 'constraint']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["type"]
|
||||
|
||||
@type.setter
|
||||
def type(self, val):
|
||||
self["type"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
Sets the value or values of the constraint boundary. When
|
||||
`operation` is set to one of the comparison values
|
||||
(=,<,>=,>,<=) "value" is expected to be a number. When
|
||||
`operation` is set to one of the interval values
|
||||
([],(),[),(],][,)(,](,)[) "value" is expected to be an array of
|
||||
two numbers where the first is the lower bound and the second
|
||||
is the upper bound.
|
||||
|
||||
The 'value' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
coloring
|
||||
Determines the coloring method showing the contour
|
||||
values. If "fill", coloring is done evenly between each
|
||||
contour level If "heatmap", a heatmap gradient coloring
|
||||
is applied between each contour level. If "lines",
|
||||
coloring is done on the contour lines. If "none", no
|
||||
coloring is applied on this trace.
|
||||
end
|
||||
Sets the end contour level value. Must be more than
|
||||
`contours.start`
|
||||
labelfont
|
||||
Sets the font used for labeling the contour levels. The
|
||||
default color comes from the lines, if shown. The
|
||||
default family and size come from `layout.font`.
|
||||
labelformat
|
||||
Sets the contour label formatting rule using d3
|
||||
formatting mini-languages which are very similar to
|
||||
those in Python. For numbers, see:
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
||||
operation
|
||||
Sets the constraint operation. "=" keeps regions equal
|
||||
to `value` "<" and "<=" keep regions less than `value`
|
||||
">" and ">=" keep regions greater than `value` "[]",
|
||||
"()", "[)", and "(]" keep regions inside `value[0]` to
|
||||
`value[1]` "][", ")(", "](", ")[" keep regions outside
|
||||
`value[0]` to value[1]` Open vs. closed intervals make
|
||||
no difference to constraint display, but all versions
|
||||
are allowed for consistency with filter transforms.
|
||||
showlabels
|
||||
Determines whether to label the contour lines with
|
||||
their values.
|
||||
showlines
|
||||
Determines whether or not the contour lines are drawn.
|
||||
Has an effect only if `contours.coloring` is set to
|
||||
"fill".
|
||||
size
|
||||
Sets the step between each contour level. Must be
|
||||
positive.
|
||||
start
|
||||
Sets the starting contour level value. Must be less
|
||||
than `contours.end`
|
||||
type
|
||||
If `levels`, the data is represented as a contour plot
|
||||
with multiple levels displayed. If `constraint`, the
|
||||
data is represented as constraints with the invalid
|
||||
region shaded as specified by the `operation` and
|
||||
`value` parameters.
|
||||
value
|
||||
Sets the value or values of the constraint boundary.
|
||||
When `operation` is set to one of the comparison values
|
||||
(=,<,>=,>,<=) "value" is expected to be a number. When
|
||||
`operation` is set to one of the interval values
|
||||
([],(),[),(],][,)(,](,)[) "value" is expected to be an
|
||||
array of two numbers where the first is the lower bound
|
||||
and the second is the upper bound.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
coloring=None,
|
||||
end=None,
|
||||
labelfont=None,
|
||||
labelformat=None,
|
||||
operation=None,
|
||||
showlabels=None,
|
||||
showlines=None,
|
||||
size=None,
|
||||
start=None,
|
||||
type=None,
|
||||
value=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Contours object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.Contours`
|
||||
coloring
|
||||
Determines the coloring method showing the contour
|
||||
values. If "fill", coloring is done evenly between each
|
||||
contour level If "heatmap", a heatmap gradient coloring
|
||||
is applied between each contour level. If "lines",
|
||||
coloring is done on the contour lines. If "none", no
|
||||
coloring is applied on this trace.
|
||||
end
|
||||
Sets the end contour level value. Must be more than
|
||||
`contours.start`
|
||||
labelfont
|
||||
Sets the font used for labeling the contour levels. The
|
||||
default color comes from the lines, if shown. The
|
||||
default family and size come from `layout.font`.
|
||||
labelformat
|
||||
Sets the contour label formatting rule using d3
|
||||
formatting mini-languages which are very similar to
|
||||
those in Python. For numbers, see:
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
||||
operation
|
||||
Sets the constraint operation. "=" keeps regions equal
|
||||
to `value` "<" and "<=" keep regions less than `value`
|
||||
">" and ">=" keep regions greater than `value` "[]",
|
||||
"()", "[)", and "(]" keep regions inside `value[0]` to
|
||||
`value[1]` "][", ")(", "](", ")[" keep regions outside
|
||||
`value[0]` to value[1]` Open vs. closed intervals make
|
||||
no difference to constraint display, but all versions
|
||||
are allowed for consistency with filter transforms.
|
||||
showlabels
|
||||
Determines whether to label the contour lines with
|
||||
their values.
|
||||
showlines
|
||||
Determines whether or not the contour lines are drawn.
|
||||
Has an effect only if `contours.coloring` is set to
|
||||
"fill".
|
||||
size
|
||||
Sets the step between each contour level. Must be
|
||||
positive.
|
||||
start
|
||||
Sets the starting contour level value. Must be less
|
||||
than `contours.end`
|
||||
type
|
||||
If `levels`, the data is represented as a contour plot
|
||||
with multiple levels displayed. If `constraint`, the
|
||||
data is represented as constraints with the invalid
|
||||
region shaded as specified by the `operation` and
|
||||
`value` parameters.
|
||||
value
|
||||
Sets the value or values of the constraint boundary.
|
||||
When `operation` is set to one of the comparison values
|
||||
(=,<,>=,>,<=) "value" is expected to be a number. When
|
||||
`operation` is set to one of the interval values
|
||||
([],(),[),(],][,)(,](,)[) "value" is expected to be an
|
||||
array of two numbers where the first is the lower bound
|
||||
and the second is the upper bound.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Contours
|
||||
"""
|
||||
super().__init__("contours")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Contours
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Contours`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("coloring", arg, coloring)
|
||||
self._set_property("end", arg, end)
|
||||
self._set_property("labelfont", arg, labelfont)
|
||||
self._set_property("labelformat", arg, labelformat)
|
||||
self._set_property("operation", arg, operation)
|
||||
self._set_property("showlabels", arg, showlabels)
|
||||
self._set_property("showlines", arg, showlines)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("start", arg, start)
|
||||
self._set_property("type", arg, type)
|
||||
self._set_property("value", arg, value)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,338 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Hoverlabel(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.hoverlabel"
|
||||
_valid_props = {
|
||||
"align",
|
||||
"alignsrc",
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"bordercolor",
|
||||
"bordercolorsrc",
|
||||
"font",
|
||||
"namelength",
|
||||
"namelengthsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def align(self):
|
||||
"""
|
||||
Sets the horizontal alignment of the text content within hover
|
||||
label box. Has an effect only if the hover label text spans
|
||||
more two or more lines
|
||||
|
||||
The 'align' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['left', 'right', 'auto']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["align"]
|
||||
|
||||
@align.setter
|
||||
def align(self, val):
|
||||
self["align"] = val
|
||||
|
||||
@property
|
||||
def alignsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `align`.
|
||||
|
||||
The 'alignsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["alignsrc"]
|
||||
|
||||
@alignsrc.setter
|
||||
def alignsrc(self, val):
|
||||
self["alignsrc"] = val
|
||||
|
||||
@property
|
||||
def bgcolor(self):
|
||||
"""
|
||||
Sets the background color of the hover labels for this trace
|
||||
|
||||
The 'bgcolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bgcolor"]
|
||||
|
||||
@bgcolor.setter
|
||||
def bgcolor(self, val):
|
||||
self["bgcolor"] = val
|
||||
|
||||
@property
|
||||
def bgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `bgcolor`.
|
||||
|
||||
The 'bgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bgcolorsrc"]
|
||||
|
||||
@bgcolorsrc.setter
|
||||
def bgcolorsrc(self, val):
|
||||
self["bgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def bordercolor(self):
|
||||
"""
|
||||
Sets the border color of the hover labels for this trace.
|
||||
|
||||
The 'bordercolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bordercolor"]
|
||||
|
||||
@bordercolor.setter
|
||||
def bordercolor(self, val):
|
||||
self["bordercolor"] = val
|
||||
|
||||
@property
|
||||
def bordercolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
|
||||
The 'bordercolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bordercolorsrc"]
|
||||
|
||||
@bordercolorsrc.setter
|
||||
def bordercolorsrc(self, val):
|
||||
self["bordercolorsrc"] = val
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets the font used in hover labels.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram2dcontour.hoverlabel.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def namelength(self):
|
||||
"""
|
||||
Sets the default length (in number of characters) of the trace
|
||||
name in the hover labels for all traces. -1 shows the whole
|
||||
name regardless of length. 0-3 shows the first 0-3 characters,
|
||||
and an integer >3 will show the whole name if it is less than
|
||||
that many characters, but if it is longer, will truncate to
|
||||
`namelength - 3` characters and add an ellipsis.
|
||||
|
||||
The 'namelength' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [-1, 9223372036854775807]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["namelength"]
|
||||
|
||||
@namelength.setter
|
||||
def namelength(self, val):
|
||||
self["namelength"] = val
|
||||
|
||||
@property
|
||||
def namelengthsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
|
||||
The 'namelengthsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["namelengthsrc"]
|
||||
|
||||
@namelengthsrc.setter
|
||||
def namelengthsrc(self, val):
|
||||
self["namelengthsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
align=None,
|
||||
alignsrc=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
bordercolor=None,
|
||||
bordercolorsrc=None,
|
||||
font=None,
|
||||
namelength=None,
|
||||
namelengthsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Hoverlabel object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.Hoverlabel`
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Hoverlabel
|
||||
"""
|
||||
super().__init__("hoverlabel")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Hoverlabel
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("align", arg, align)
|
||||
self._set_property("alignsrc", arg, alignsrc)
|
||||
self._set_property("bgcolor", arg, bgcolor)
|
||||
self._set_property("bgcolorsrc", arg, bgcolorsrc)
|
||||
self._set_property("bordercolor", arg, bordercolor)
|
||||
self._set_property("bordercolorsrc", arg, bordercolorsrc)
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("namelength", arg, namelength)
|
||||
self._set_property("namelengthsrc", arg, namelengthsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,104 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Legendgrouptitle(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.legendgrouptitle"
|
||||
_valid_props = {"font", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this legend group's title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of the legend group.
|
||||
|
||||
The 'text' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["text"]
|
||||
|
||||
@text.setter
|
||||
def text(self, val):
|
||||
self["text"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets this legend group's title font.
|
||||
text
|
||||
Sets the title of the legend group.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, text=None, **kwargs):
|
||||
"""
|
||||
Construct a new Legendgrouptitle object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.Legendgrouptitle`
|
||||
font
|
||||
Sets this legend group's title font.
|
||||
text
|
||||
Sets the title of the legend group.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Legendgrouptitle
|
||||
"""
|
||||
super().__init__("legendgrouptitle")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Legendgrouptitle`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,170 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Line(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.line"
|
||||
_valid_props = {"color", "dash", "smoothing", "width"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the color of the contour level. Has no effect if
|
||||
`contours.coloring` is set to "lines".
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def dash(self):
|
||||
"""
|
||||
Sets the dash style of lines. Set to a dash type string
|
||||
("solid", "dot", "dash", "longdash", "dashdot", or
|
||||
"longdashdot") or a dash length list in px (eg
|
||||
"5px,10px,2px,2px").
|
||||
|
||||
The 'dash' property is an enumeration that may be specified as:
|
||||
- One of the following dash styles:
|
||||
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
|
||||
- A string containing a dash length list in pixels or percentages
|
||||
(e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["dash"]
|
||||
|
||||
@dash.setter
|
||||
def dash(self, val):
|
||||
self["dash"] = val
|
||||
|
||||
@property
|
||||
def smoothing(self):
|
||||
"""
|
||||
Sets the amount of smoothing for the contour lines, where 0
|
||||
corresponds to no smoothing.
|
||||
|
||||
The 'smoothing' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1.3]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["smoothing"]
|
||||
|
||||
@smoothing.setter
|
||||
def smoothing(self, val):
|
||||
self["smoothing"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the contour line width in (in px)
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the color of the contour level. Has no effect if
|
||||
`contours.coloring` is set to "lines".
|
||||
dash
|
||||
Sets the dash style of lines. Set to a dash type string
|
||||
("solid", "dot", "dash", "longdash", "dashdot", or
|
||||
"longdashdot") or a dash length list in px (eg
|
||||
"5px,10px,2px,2px").
|
||||
smoothing
|
||||
Sets the amount of smoothing for the contour lines,
|
||||
where 0 corresponds to no smoothing.
|
||||
width
|
||||
Sets the contour line width in (in px)
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self, arg=None, color=None, dash=None, smoothing=None, width=None, **kwargs
|
||||
):
|
||||
"""
|
||||
Construct a new Line object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.Line`
|
||||
color
|
||||
Sets the color of the contour level. Has no effect if
|
||||
`contours.coloring` is set to "lines".
|
||||
dash
|
||||
Sets the dash style of lines. Set to a dash type string
|
||||
("solid", "dot", "dash", "longdash", "dashdot", or
|
||||
"longdashdot") or a dash length list in px (eg
|
||||
"5px,10px,2px,2px").
|
||||
smoothing
|
||||
Sets the amount of smoothing for the contour lines,
|
||||
where 0 corresponds to no smoothing.
|
||||
width
|
||||
Sets the contour line width in (in px)
|
||||
|
||||
Returns
|
||||
-------
|
||||
Line
|
||||
"""
|
||||
super().__init__("line")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Line`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("dash", arg, dash)
|
||||
self._set_property("smoothing", arg, smoothing)
|
||||
self._set_property("width", arg, width)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,102 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Marker(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.marker"
|
||||
_valid_props = {"color", "colorsrc"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the aggregation data.
|
||||
|
||||
The 'color' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the aggregation data.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, colorsrc=None, **kwargs):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.Marker`
|
||||
color
|
||||
Sets the aggregation data.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Marker
|
||||
"""
|
||||
super().__init__("marker")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,114 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Stream(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.stream"
|
||||
_valid_props = {"maxpoints", "token"}
|
||||
|
||||
@property
|
||||
def maxpoints(self):
|
||||
"""
|
||||
Sets the maximum number of points to keep on the plots from an
|
||||
incoming stream. If `maxpoints` is set to 50, only the newest
|
||||
50 points will be displayed on the plot.
|
||||
|
||||
The 'maxpoints' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 10000]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["maxpoints"]
|
||||
|
||||
@maxpoints.setter
|
||||
def maxpoints(self, val):
|
||||
self["maxpoints"] = val
|
||||
|
||||
@property
|
||||
def token(self):
|
||||
"""
|
||||
The stream id number links a data trace on a plot with a
|
||||
stream. See https://chart-studio.plotly.com/settings for more
|
||||
details.
|
||||
|
||||
The 'token' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["token"]
|
||||
|
||||
@token.setter
|
||||
def token(self, val):
|
||||
self["token"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
maxpoints
|
||||
Sets the maximum number of points to keep on the plots
|
||||
from an incoming stream. If `maxpoints` is set to 50,
|
||||
only the newest 50 points will be displayed on the
|
||||
plot.
|
||||
token
|
||||
The stream id number links a data trace on a plot with
|
||||
a stream. See https://chart-studio.plotly.com/settings
|
||||
for more details.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
|
||||
"""
|
||||
Construct a new Stream object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.Stream`
|
||||
maxpoints
|
||||
Sets the maximum number of points to keep on the plots
|
||||
from an incoming stream. If `maxpoints` is set to 50,
|
||||
only the newest 50 points will be displayed on the
|
||||
plot.
|
||||
token
|
||||
The stream id number links a data trace on a plot with
|
||||
a stream. See https://chart-studio.plotly.com/settings
|
||||
for more details.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Stream
|
||||
"""
|
||||
super().__init__("stream")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Stream
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Stream`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("maxpoints", arg, maxpoints)
|
||||
self._set_property("token", arg, token)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,335 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Textfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.textfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
For this trace it only has an effect if `coloring` is set to
|
||||
"heatmap". Sets the text font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.Textfont`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Textfont
|
||||
"""
|
||||
super().__init__("textfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,187 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class XBins(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.xbins"
|
||||
_valid_props = {"end", "size", "start"}
|
||||
|
||||
@property
|
||||
def end(self):
|
||||
"""
|
||||
Sets the end value for the x axis bins. The last bin may not
|
||||
end exactly at this value, we increment the bin edge by `size`
|
||||
from `start` until we reach or exceed `end`. Defaults to the
|
||||
maximum data value. Like `start`, for dates use a date string,
|
||||
and for category data `end` is based on the category serial
|
||||
numbers.
|
||||
|
||||
The 'end' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["end"]
|
||||
|
||||
@end.setter
|
||||
def end(self, val):
|
||||
self["end"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
Sets the size of each x axis bin. Default behavior: If `nbinsx`
|
||||
is 0 or omitted, we choose a nice round bin size such that the
|
||||
number of bins is about the same as the typical number of
|
||||
samples in each bin. If `nbinsx` is provided, we choose a nice
|
||||
round bin size giving no more than that many bins. For date
|
||||
data, use milliseconds or "M<n>" for months, as in
|
||||
`axis.dtick`. For category data, the number of categories to
|
||||
bin together (always defaults to 1).
|
||||
|
||||
The 'size' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def start(self):
|
||||
"""
|
||||
Sets the starting value for the x axis bins. Defaults to the
|
||||
minimum data value, shifted down if necessary to make nice
|
||||
round values and to remove ambiguous bin edges. For example, if
|
||||
most of the data is integers we shift the bin edges 0.5 down,
|
||||
so a `size` of 5 would have a default `start` of -0.5, so it is
|
||||
clear that 0-4 are in the first bin, 5-9 in the second, but
|
||||
continuous data gets a start of 0 and bins [0,5), [5,10) etc.
|
||||
Dates behave similarly, and `start` should be a date string.
|
||||
For category data, `start` is based on the category serial
|
||||
numbers, and defaults to -0.5.
|
||||
|
||||
The 'start' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["start"]
|
||||
|
||||
@start.setter
|
||||
def start(self, val):
|
||||
self["start"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
end
|
||||
Sets the end value for the x axis bins. The last bin
|
||||
may not end exactly at this value, we increment the bin
|
||||
edge by `size` from `start` until we reach or exceed
|
||||
`end`. Defaults to the maximum data value. Like
|
||||
`start`, for dates use a date string, and for category
|
||||
data `end` is based on the category serial numbers.
|
||||
size
|
||||
Sets the size of each x axis bin. Default behavior: If
|
||||
`nbinsx` is 0 or omitted, we choose a nice round bin
|
||||
size such that the number of bins is about the same as
|
||||
the typical number of samples in each bin. If `nbinsx`
|
||||
is provided, we choose a nice round bin size giving no
|
||||
more than that many bins. For date data, use
|
||||
milliseconds or "M<n>" for months, as in `axis.dtick`.
|
||||
For category data, the number of categories to bin
|
||||
together (always defaults to 1).
|
||||
start
|
||||
Sets the starting value for the x axis bins. Defaults
|
||||
to the minimum data value, shifted down if necessary to
|
||||
make nice round values and to remove ambiguous bin
|
||||
edges. For example, if most of the data is integers we
|
||||
shift the bin edges 0.5 down, so a `size` of 5 would
|
||||
have a default `start` of -0.5, so it is clear that 0-4
|
||||
are in the first bin, 5-9 in the second, but continuous
|
||||
data gets a start of 0 and bins [0,5), [5,10) etc.
|
||||
Dates behave similarly, and `start` should be a date
|
||||
string. For category data, `start` is based on the
|
||||
category serial numbers, and defaults to -0.5.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
|
||||
"""
|
||||
Construct a new XBins object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.XBins`
|
||||
end
|
||||
Sets the end value for the x axis bins. The last bin
|
||||
may not end exactly at this value, we increment the bin
|
||||
edge by `size` from `start` until we reach or exceed
|
||||
`end`. Defaults to the maximum data value. Like
|
||||
`start`, for dates use a date string, and for category
|
||||
data `end` is based on the category serial numbers.
|
||||
size
|
||||
Sets the size of each x axis bin. Default behavior: If
|
||||
`nbinsx` is 0 or omitted, we choose a nice round bin
|
||||
size such that the number of bins is about the same as
|
||||
the typical number of samples in each bin. If `nbinsx`
|
||||
is provided, we choose a nice round bin size giving no
|
||||
more than that many bins. For date data, use
|
||||
milliseconds or "M<n>" for months, as in `axis.dtick`.
|
||||
For category data, the number of categories to bin
|
||||
together (always defaults to 1).
|
||||
start
|
||||
Sets the starting value for the x axis bins. Defaults
|
||||
to the minimum data value, shifted down if necessary to
|
||||
make nice round values and to remove ambiguous bin
|
||||
edges. For example, if most of the data is integers we
|
||||
shift the bin edges 0.5 down, so a `size` of 5 would
|
||||
have a default `start` of -0.5, so it is clear that 0-4
|
||||
are in the first bin, 5-9 in the second, but continuous
|
||||
data gets a start of 0 and bins [0,5), [5,10) etc.
|
||||
Dates behave similarly, and `start` should be a date
|
||||
string. For category data, `start` is based on the
|
||||
category serial numbers, and defaults to -0.5.
|
||||
|
||||
Returns
|
||||
-------
|
||||
XBins
|
||||
"""
|
||||
super().__init__("xbins")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.XBins
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.XBins`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("end", arg, end)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("start", arg, start)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,187 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class YBins(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour"
|
||||
_path_str = "histogram2dcontour.ybins"
|
||||
_valid_props = {"end", "size", "start"}
|
||||
|
||||
@property
|
||||
def end(self):
|
||||
"""
|
||||
Sets the end value for the y axis bins. The last bin may not
|
||||
end exactly at this value, we increment the bin edge by `size`
|
||||
from `start` until we reach or exceed `end`. Defaults to the
|
||||
maximum data value. Like `start`, for dates use a date string,
|
||||
and for category data `end` is based on the category serial
|
||||
numbers.
|
||||
|
||||
The 'end' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["end"]
|
||||
|
||||
@end.setter
|
||||
def end(self, val):
|
||||
self["end"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
Sets the size of each y axis bin. Default behavior: If `nbinsy`
|
||||
is 0 or omitted, we choose a nice round bin size such that the
|
||||
number of bins is about the same as the typical number of
|
||||
samples in each bin. If `nbinsy` is provided, we choose a nice
|
||||
round bin size giving no more than that many bins. For date
|
||||
data, use milliseconds or "M<n>" for months, as in
|
||||
`axis.dtick`. For category data, the number of categories to
|
||||
bin together (always defaults to 1).
|
||||
|
||||
The 'size' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def start(self):
|
||||
"""
|
||||
Sets the starting value for the y axis bins. Defaults to the
|
||||
minimum data value, shifted down if necessary to make nice
|
||||
round values and to remove ambiguous bin edges. For example, if
|
||||
most of the data is integers we shift the bin edges 0.5 down,
|
||||
so a `size` of 5 would have a default `start` of -0.5, so it is
|
||||
clear that 0-4 are in the first bin, 5-9 in the second, but
|
||||
continuous data gets a start of 0 and bins [0,5), [5,10) etc.
|
||||
Dates behave similarly, and `start` should be a date string.
|
||||
For category data, `start` is based on the category serial
|
||||
numbers, and defaults to -0.5.
|
||||
|
||||
The 'start' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["start"]
|
||||
|
||||
@start.setter
|
||||
def start(self, val):
|
||||
self["start"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
end
|
||||
Sets the end value for the y axis bins. The last bin
|
||||
may not end exactly at this value, we increment the bin
|
||||
edge by `size` from `start` until we reach or exceed
|
||||
`end`. Defaults to the maximum data value. Like
|
||||
`start`, for dates use a date string, and for category
|
||||
data `end` is based on the category serial numbers.
|
||||
size
|
||||
Sets the size of each y axis bin. Default behavior: If
|
||||
`nbinsy` is 0 or omitted, we choose a nice round bin
|
||||
size such that the number of bins is about the same as
|
||||
the typical number of samples in each bin. If `nbinsy`
|
||||
is provided, we choose a nice round bin size giving no
|
||||
more than that many bins. For date data, use
|
||||
milliseconds or "M<n>" for months, as in `axis.dtick`.
|
||||
For category data, the number of categories to bin
|
||||
together (always defaults to 1).
|
||||
start
|
||||
Sets the starting value for the y axis bins. Defaults
|
||||
to the minimum data value, shifted down if necessary to
|
||||
make nice round values and to remove ambiguous bin
|
||||
edges. For example, if most of the data is integers we
|
||||
shift the bin edges 0.5 down, so a `size` of 5 would
|
||||
have a default `start` of -0.5, so it is clear that 0-4
|
||||
are in the first bin, 5-9 in the second, but continuous
|
||||
data gets a start of 0 and bins [0,5), [5,10) etc.
|
||||
Dates behave similarly, and `start` should be a date
|
||||
string. For category data, `start` is based on the
|
||||
category serial numbers, and defaults to -0.5.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
|
||||
"""
|
||||
Construct a new YBins object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram2dcontour.YBins`
|
||||
end
|
||||
Sets the end value for the y axis bins. The last bin
|
||||
may not end exactly at this value, we increment the bin
|
||||
edge by `size` from `start` until we reach or exceed
|
||||
`end`. Defaults to the maximum data value. Like
|
||||
`start`, for dates use a date string, and for category
|
||||
data `end` is based on the category serial numbers.
|
||||
size
|
||||
Sets the size of each y axis bin. Default behavior: If
|
||||
`nbinsy` is 0 or omitted, we choose a nice round bin
|
||||
size such that the number of bins is about the same as
|
||||
the typical number of samples in each bin. If `nbinsy`
|
||||
is provided, we choose a nice round bin size giving no
|
||||
more than that many bins. For date data, use
|
||||
milliseconds or "M<n>" for months, as in `axis.dtick`.
|
||||
For category data, the number of categories to bin
|
||||
together (always defaults to 1).
|
||||
start
|
||||
Sets the starting value for the y axis bins. Defaults
|
||||
to the minimum data value, shifted down if necessary to
|
||||
make nice round values and to remove ambiguous bin
|
||||
edges. For example, if most of the data is integers we
|
||||
shift the bin edges 0.5 down, so a `size` of 5 would
|
||||
have a default `start` of -0.5, so it is clear that 0-4
|
||||
are in the first bin, 5-9 in the second, but continuous
|
||||
data gets a start of 0 and bins [0,5), [5,10) etc.
|
||||
Dates behave similarly, and `start` should be a date
|
||||
string. For category data, `start` is based on the
|
||||
category serial numbers, and defaults to -0.5.
|
||||
|
||||
Returns
|
||||
-------
|
||||
YBins
|
||||
"""
|
||||
super().__init__("ybins")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.YBins
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.YBins`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("end", arg, end)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("start", arg, start)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"],
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.colorbar"
|
||||
_path_str = "histogram2dcontour.colorbar.tickfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Tickfont object
|
||||
|
||||
Sets the color bar's tick label font
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.colorbar.Tickfont`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Tickfont
|
||||
"""
|
||||
super().__init__("tickfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,241 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickformatstop(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.colorbar"
|
||||
_path_str = "histogram2dcontour.colorbar.tickformatstop"
|
||||
_valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"}
|
||||
|
||||
@property
|
||||
def dtickrange(self):
|
||||
"""
|
||||
range [*min*, *max*], where "min", "max" - dtick values which
|
||||
describe some zoom level, it is possible to omit "min" or "max"
|
||||
value by passing "null"
|
||||
|
||||
The 'dtickrange' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'dtickrange[0]' property accepts values of any type
|
||||
(1) The 'dtickrange[1]' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["dtickrange"]
|
||||
|
||||
@dtickrange.setter
|
||||
def dtickrange(self, val):
|
||||
self["dtickrange"] = val
|
||||
|
||||
@property
|
||||
def enabled(self):
|
||||
"""
|
||||
Determines whether or not this stop is used. If `false`, this
|
||||
stop is ignored even within its `dtickrange`.
|
||||
|
||||
The 'enabled' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["enabled"]
|
||||
|
||||
@enabled.setter
|
||||
def enabled(self, val):
|
||||
self["enabled"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
When used in a template, named items are created in the output
|
||||
figure in addition to any items the figure already has in this
|
||||
array. You can modify these items in the output figure by
|
||||
making your own item with `templateitemname` matching this
|
||||
`name` alongside your modifications (including `visible: false`
|
||||
or `enabled: false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def templateitemname(self):
|
||||
"""
|
||||
Used to refer to a named item in this array in the template.
|
||||
Named items from the template will be created even without a
|
||||
matching item in the input figure, but you can modify one by
|
||||
making an item with `templateitemname` matching its `name`,
|
||||
alongside your modifications (including `visible: false` or
|
||||
`enabled: false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you explicitly
|
||||
show it with `visible: true`.
|
||||
|
||||
The 'templateitemname' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["templateitemname"]
|
||||
|
||||
@templateitemname.setter
|
||||
def templateitemname(self, val):
|
||||
self["templateitemname"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
string - dtickformat for described zoom level, the same as
|
||||
"tickformat"
|
||||
|
||||
The 'value' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
dtickrange
|
||||
range [*min*, *max*], where "min", "max" - dtick values
|
||||
which describe some zoom level, it is possible to omit
|
||||
"min" or "max" value by passing "null"
|
||||
enabled
|
||||
Determines whether or not this stop is used. If
|
||||
`false`, this stop is ignored even within its
|
||||
`dtickrange`.
|
||||
name
|
||||
When used in a template, named items are created in the
|
||||
output figure in addition to any items the figure
|
||||
already has in this array. You can modify these items
|
||||
in the output figure by making your own item with
|
||||
`templateitemname` matching this `name` alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
templateitemname
|
||||
Used to refer to a named item in this array in the
|
||||
template. Named items from the template will be created
|
||||
even without a matching item in the input figure, but
|
||||
you can modify one by making an item with
|
||||
`templateitemname` matching its `name`, alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you
|
||||
explicitly show it with `visible: true`.
|
||||
value
|
||||
string - dtickformat for described zoom level, the same
|
||||
as "tickformat"
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
dtickrange=None,
|
||||
enabled=None,
|
||||
name=None,
|
||||
templateitemname=None,
|
||||
value=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Tickformatstop object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.colorbar.Tickformatstop`
|
||||
dtickrange
|
||||
range [*min*, *max*], where "min", "max" - dtick values
|
||||
which describe some zoom level, it is possible to omit
|
||||
"min" or "max" value by passing "null"
|
||||
enabled
|
||||
Determines whether or not this stop is used. If
|
||||
`false`, this stop is ignored even within its
|
||||
`dtickrange`.
|
||||
name
|
||||
When used in a template, named items are created in the
|
||||
output figure in addition to any items the figure
|
||||
already has in this array. You can modify these items
|
||||
in the output figure by making your own item with
|
||||
`templateitemname` matching this `name` alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
templateitemname
|
||||
Used to refer to a named item in this array in the
|
||||
template. Named items from the template will be created
|
||||
even without a matching item in the input figure, but
|
||||
you can modify one by making an item with
|
||||
`templateitemname` matching its `name`, alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you
|
||||
explicitly show it with `visible: true`.
|
||||
value
|
||||
string - dtickformat for described zoom level, the same
|
||||
as "tickformat"
|
||||
|
||||
Returns
|
||||
-------
|
||||
Tickformatstop
|
||||
"""
|
||||
super().__init__("tickformatstops")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("dtickrange", arg, dtickrange)
|
||||
self._set_property("enabled", arg, enabled)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("templateitemname", arg, templateitemname)
|
||||
self._set_property("value", arg, value)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,136 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Title(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.colorbar"
|
||||
_path_str = "histogram2dcontour.colorbar.title"
|
||||
_valid_props = {"font", "side", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this color bar's title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram2dcontour.colorbar.title.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def side(self):
|
||||
"""
|
||||
Determines the location of color bar's title with respect to
|
||||
the color bar. Defaults to "top" when `orientation` if "v" and
|
||||
defaults to "right" when `orientation` if "h".
|
||||
|
||||
The 'side' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['right', 'top', 'bottom']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["side"]
|
||||
|
||||
@side.setter
|
||||
def side(self, val):
|
||||
self["side"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of the color bar.
|
||||
|
||||
The 'text' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["text"]
|
||||
|
||||
@text.setter
|
||||
def text(self, val):
|
||||
self["text"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets this color bar's title font.
|
||||
side
|
||||
Determines the location of color bar's title with
|
||||
respect to the color bar. Defaults to "top" when
|
||||
`orientation` if "v" and defaults to "right" when
|
||||
`orientation` if "h".
|
||||
text
|
||||
Sets the title of the color bar.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
|
||||
"""
|
||||
Construct a new Title object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.colorbar.Title`
|
||||
font
|
||||
Sets this color bar's title font.
|
||||
side
|
||||
Determines the location of color bar's title with
|
||||
respect to the color bar. Defaults to "top" when
|
||||
`orientation` if "v" and defaults to "right" when
|
||||
`orientation` if "h".
|
||||
text
|
||||
Sets the title of the color bar.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Title
|
||||
"""
|
||||
super().__init__("title")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Title`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("side", arg, side)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.colorbar.title"
|
||||
_path_str = "histogram2dcontour.colorbar.title.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets this color bar's title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.colorbar.title.Font`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,11 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._labelfont import Labelfont
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [], ["._labelfont.Labelfont"]
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,336 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Labelfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.contours"
|
||||
_path_str = "histogram2dcontour.contours.labelfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Labelfont object
|
||||
|
||||
Sets the font used for labeling the contour levels. The default
|
||||
color comes from the lines, if shown. The default family and
|
||||
size come from `layout.font`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.contours.Labelfont`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Labelfont
|
||||
"""
|
||||
super().__init__("labelfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.contours.Labelfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.contours.Labelfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,587 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.hoverlabel"
|
||||
_path_str = "histogram2dcontour.hoverlabel.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"colorsrc",
|
||||
"family",
|
||||
"familysrc",
|
||||
"lineposition",
|
||||
"linepositionsrc",
|
||||
"shadow",
|
||||
"shadowsrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"style",
|
||||
"stylesrc",
|
||||
"textcase",
|
||||
"textcasesrc",
|
||||
"variant",
|
||||
"variantsrc",
|
||||
"weight",
|
||||
"weightsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def familysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `family`.
|
||||
|
||||
The 'familysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["familysrc"]
|
||||
|
||||
@familysrc.setter
|
||||
def familysrc(self, val):
|
||||
self["familysrc"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def linepositionsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
|
||||
The 'linepositionsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["linepositionsrc"]
|
||||
|
||||
@linepositionsrc.setter
|
||||
def linepositionsrc(self, val):
|
||||
self["linepositionsrc"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def shadowsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shadow`.
|
||||
|
||||
The 'shadowsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadowsrc"]
|
||||
|
||||
@shadowsrc.setter
|
||||
def shadowsrc(self, val):
|
||||
self["shadowsrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def stylesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `style`.
|
||||
|
||||
The 'stylesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["stylesrc"]
|
||||
|
||||
@stylesrc.setter
|
||||
def stylesrc(self, val):
|
||||
self["stylesrc"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def textcasesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `textcase`.
|
||||
|
||||
The 'textcasesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["textcasesrc"]
|
||||
|
||||
@textcasesrc.setter
|
||||
def textcasesrc(self, val):
|
||||
self["textcasesrc"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def variantsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `variant`.
|
||||
|
||||
The 'variantsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["variantsrc"]
|
||||
|
||||
@variantsrc.setter
|
||||
def variantsrc(self, val):
|
||||
self["variantsrc"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def weightsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `weight`.
|
||||
|
||||
The 'weightsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["weightsrc"]
|
||||
|
||||
@weightsrc.setter
|
||||
def weightsrc(self, val):
|
||||
self["weightsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
lineposition=None,
|
||||
linepositionsrc=None,
|
||||
shadow=None,
|
||||
shadowsrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
style=None,
|
||||
stylesrc=None,
|
||||
textcase=None,
|
||||
textcasesrc=None,
|
||||
variant=None,
|
||||
variantsrc=None,
|
||||
weight=None,
|
||||
weightsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets the font used in hover labels.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.hoverlabel.Font`
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.hoverlabel.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("familysrc", arg, familysrc)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("linepositionsrc", arg, linepositionsrc)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("shadowsrc", arg, shadowsrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("stylesrc", arg, stylesrc)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("textcasesrc", arg, textcasesrc)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("variantsrc", arg, variantsrc)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._set_property("weightsrc", arg, weightsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram2dcontour.legendgrouptitle"
|
||||
_path_str = "histogram2dcontour.legendgrouptitle.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets this legend group's title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcon
|
||||
tour.legendgrouptitle.Font`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
Reference in New Issue
Block a user