done
This commit is contained in:
@ -0,0 +1,46 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._cumulative import Cumulative
|
||||
from ._error_x import ErrorX
|
||||
from ._error_y import ErrorY
|
||||
from ._hoverlabel import Hoverlabel
|
||||
from ._insidetextfont import Insidetextfont
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._marker import Marker
|
||||
from ._outsidetextfont import Outsidetextfont
|
||||
from ._selected import Selected
|
||||
from ._stream import Stream
|
||||
from ._textfont import Textfont
|
||||
from ._unselected import Unselected
|
||||
from ._xbins import XBins
|
||||
from ._ybins import YBins
|
||||
from . import hoverlabel
|
||||
from . import legendgrouptitle
|
||||
from . import marker
|
||||
from . import selected
|
||||
from . import unselected
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"],
|
||||
[
|
||||
"._cumulative.Cumulative",
|
||||
"._error_x.ErrorX",
|
||||
"._error_y.ErrorY",
|
||||
"._hoverlabel.Hoverlabel",
|
||||
"._insidetextfont.Insidetextfont",
|
||||
"._legendgrouptitle.Legendgrouptitle",
|
||||
"._marker.Marker",
|
||||
"._outsidetextfont.Outsidetextfont",
|
||||
"._selected.Selected",
|
||||
"._stream.Stream",
|
||||
"._textfont.Textfont",
|
||||
"._unselected.Unselected",
|
||||
"._xbins.XBins",
|
||||
"._ybins.YBins",
|
||||
],
|
||||
)
|
@ -0,0 +1,173 @@
|
||||
# --- 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 Cumulative(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.cumulative"
|
||||
_valid_props = {"currentbin", "direction", "enabled"}
|
||||
|
||||
@property
|
||||
def currentbin(self):
|
||||
"""
|
||||
Only applies if cumulative is enabled. Sets whether the current
|
||||
bin is included, excluded, or has half of its value included in
|
||||
the current cumulative value. "include" is the default for
|
||||
compatibility with various other tools, however it introduces a
|
||||
half-bin bias to the results. "exclude" makes the opposite
|
||||
half-bin bias, and "half" removes it.
|
||||
|
||||
The 'currentbin' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['include', 'exclude', 'half']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["currentbin"]
|
||||
|
||||
@currentbin.setter
|
||||
def currentbin(self, val):
|
||||
self["currentbin"] = val
|
||||
|
||||
@property
|
||||
def direction(self):
|
||||
"""
|
||||
Only applies if cumulative is enabled. If "increasing"
|
||||
(default) we sum all prior bins, so the result increases from
|
||||
left to right. If "decreasing" we sum later bins so the result
|
||||
decreases from left to right.
|
||||
|
||||
The 'direction' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['increasing', 'decreasing']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["direction"]
|
||||
|
||||
@direction.setter
|
||||
def direction(self, val):
|
||||
self["direction"] = val
|
||||
|
||||
@property
|
||||
def enabled(self):
|
||||
"""
|
||||
If true, display the cumulative distribution by summing the
|
||||
binned values. Use the `direction` and `centralbin` attributes
|
||||
to tune the accumulation method. Note: in this mode, the
|
||||
"density" `histnorm` settings behave the same as their
|
||||
equivalents without "density": "" and "density" both rise to
|
||||
the number of data points, and "probability" and *probability
|
||||
density* both rise to the number of sample points.
|
||||
|
||||
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 _prop_descriptions(self):
|
||||
return """\
|
||||
currentbin
|
||||
Only applies if cumulative is enabled. Sets whether the
|
||||
current bin is included, excluded, or has half of its
|
||||
value included in the current cumulative value.
|
||||
"include" is the default for compatibility with various
|
||||
other tools, however it introduces a half-bin bias to
|
||||
the results. "exclude" makes the opposite half-bin
|
||||
bias, and "half" removes it.
|
||||
direction
|
||||
Only applies if cumulative is enabled. If "increasing"
|
||||
(default) we sum all prior bins, so the result
|
||||
increases from left to right. If "decreasing" we sum
|
||||
later bins so the result decreases from left to right.
|
||||
enabled
|
||||
If true, display the cumulative distribution by summing
|
||||
the binned values. Use the `direction` and `centralbin`
|
||||
attributes to tune the accumulation method. Note: in
|
||||
this mode, the "density" `histnorm` settings behave the
|
||||
same as their equivalents without "density": "" and
|
||||
"density" both rise to the number of data points, and
|
||||
"probability" and *probability density* both rise to
|
||||
the number of sample points.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self, arg=None, currentbin=None, direction=None, enabled=None, **kwargs
|
||||
):
|
||||
"""
|
||||
Construct a new Cumulative object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.Cumulative`
|
||||
currentbin
|
||||
Only applies if cumulative is enabled. Sets whether the
|
||||
current bin is included, excluded, or has half of its
|
||||
value included in the current cumulative value.
|
||||
"include" is the default for compatibility with various
|
||||
other tools, however it introduces a half-bin bias to
|
||||
the results. "exclude" makes the opposite half-bin
|
||||
bias, and "half" removes it.
|
||||
direction
|
||||
Only applies if cumulative is enabled. If "increasing"
|
||||
(default) we sum all prior bins, so the result
|
||||
increases from left to right. If "decreasing" we sum
|
||||
later bins so the result decreases from left to right.
|
||||
enabled
|
||||
If true, display the cumulative distribution by summing
|
||||
the binned values. Use the `direction` and `centralbin`
|
||||
attributes to tune the accumulation method. Note: in
|
||||
this mode, the "density" `histnorm` settings behave the
|
||||
same as their equivalents without "density": "" and
|
||||
"density" both rise to the number of data points, and
|
||||
"probability" and *probability density* both rise to
|
||||
the number of sample points.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Cumulative
|
||||
"""
|
||||
super().__init__("cumulative")
|
||||
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.histogram.Cumulative
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.Cumulative`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("currentbin", arg, currentbin)
|
||||
self._set_property("direction", arg, direction)
|
||||
self._set_property("enabled", arg, enabled)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,503 @@
|
||||
# --- 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 ErrorX(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.error_x"
|
||||
_valid_props = {
|
||||
"array",
|
||||
"arrayminus",
|
||||
"arrayminussrc",
|
||||
"arraysrc",
|
||||
"color",
|
||||
"copy_ystyle",
|
||||
"symmetric",
|
||||
"thickness",
|
||||
"traceref",
|
||||
"tracerefminus",
|
||||
"type",
|
||||
"value",
|
||||
"valueminus",
|
||||
"visible",
|
||||
"width",
|
||||
}
|
||||
|
||||
@property
|
||||
def array(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar.
|
||||
Values are plotted relative to the underlying data.
|
||||
|
||||
The 'array' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["array"]
|
||||
|
||||
@array.setter
|
||||
def array(self, val):
|
||||
self["array"] = val
|
||||
|
||||
@property
|
||||
def arrayminus(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar in the
|
||||
bottom (left) direction for vertical (horizontal) bars Values
|
||||
are plotted relative to the underlying data.
|
||||
|
||||
The 'arrayminus' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["arrayminus"]
|
||||
|
||||
@arrayminus.setter
|
||||
def arrayminus(self, val):
|
||||
self["arrayminus"] = val
|
||||
|
||||
@property
|
||||
def arrayminussrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
|
||||
The 'arrayminussrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arrayminussrc"]
|
||||
|
||||
@arrayminussrc.setter
|
||||
def arrayminussrc(self, val):
|
||||
self["arrayminussrc"] = val
|
||||
|
||||
@property
|
||||
def arraysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `array`.
|
||||
|
||||
The 'arraysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arraysrc"]
|
||||
|
||||
@arraysrc.setter
|
||||
def arraysrc(self, val):
|
||||
self["arraysrc"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the stroke color of the error bars.
|
||||
|
||||
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 copy_ystyle(self):
|
||||
"""
|
||||
The 'copy_ystyle' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["copy_ystyle"]
|
||||
|
||||
@copy_ystyle.setter
|
||||
def copy_ystyle(self, val):
|
||||
self["copy_ystyle"] = val
|
||||
|
||||
@property
|
||||
def symmetric(self):
|
||||
"""
|
||||
Determines whether or not the error bars have the same length
|
||||
in both direction (top/bottom for vertical bars, left/right for
|
||||
horizontal bars.
|
||||
|
||||
The 'symmetric' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["symmetric"]
|
||||
|
||||
@symmetric.setter
|
||||
def symmetric(self, val):
|
||||
self["symmetric"] = val
|
||||
|
||||
@property
|
||||
def thickness(self):
|
||||
"""
|
||||
Sets the thickness (in px) of the error bars.
|
||||
|
||||
The 'thickness' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["thickness"]
|
||||
|
||||
@thickness.setter
|
||||
def thickness(self, val):
|
||||
self["thickness"] = val
|
||||
|
||||
@property
|
||||
def traceref(self):
|
||||
"""
|
||||
The 'traceref' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["traceref"]
|
||||
|
||||
@traceref.setter
|
||||
def traceref(self, val):
|
||||
self["traceref"] = val
|
||||
|
||||
@property
|
||||
def tracerefminus(self):
|
||||
"""
|
||||
The 'tracerefminus' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["tracerefminus"]
|
||||
|
||||
@tracerefminus.setter
|
||||
def tracerefminus(self, val):
|
||||
self["tracerefminus"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
"""
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value. Set this
|
||||
constant in `value`. If "percent", the bar lengths correspond
|
||||
to a percentage of underlying data. Set this percentage in
|
||||
`value`. If "sqrt", the bar lengths correspond to the square of
|
||||
the underlying data. If "data", the bar lengths are set with
|
||||
data set `array`.
|
||||
|
||||
The 'type' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['percent', 'constant', 'sqrt', 'data']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["type"]
|
||||
|
||||
@type.setter
|
||||
def type(self, val):
|
||||
self["type"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars.
|
||||
|
||||
The 'value' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def valueminus(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars in the bottom
|
||||
(left) direction for vertical (horizontal) bars
|
||||
|
||||
The 'valueminus' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["valueminus"]
|
||||
|
||||
@valueminus.setter
|
||||
def valueminus(self, val):
|
||||
self["valueminus"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this set of error bars is visible.
|
||||
|
||||
The 'visible' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the cross-bar at both ends of the
|
||||
error bars.
|
||||
|
||||
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 """\
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
copy_ystyle
|
||||
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
array=None,
|
||||
arrayminus=None,
|
||||
arrayminussrc=None,
|
||||
arraysrc=None,
|
||||
color=None,
|
||||
copy_ystyle=None,
|
||||
symmetric=None,
|
||||
thickness=None,
|
||||
traceref=None,
|
||||
tracerefminus=None,
|
||||
type=None,
|
||||
value=None,
|
||||
valueminus=None,
|
||||
visible=None,
|
||||
width=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new ErrorX object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.ErrorX`
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
copy_ystyle
|
||||
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ErrorX
|
||||
"""
|
||||
super().__init__("error_x")
|
||||
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.histogram.ErrorX
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.ErrorX`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("array", arg, array)
|
||||
self._set_property("arrayminus", arg, arrayminus)
|
||||
self._set_property("arrayminussrc", arg, arrayminussrc)
|
||||
self._set_property("arraysrc", arg, arraysrc)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("copy_ystyle", arg, copy_ystyle)
|
||||
self._set_property("symmetric", arg, symmetric)
|
||||
self._set_property("thickness", arg, thickness)
|
||||
self._set_property("traceref", arg, traceref)
|
||||
self._set_property("tracerefminus", arg, tracerefminus)
|
||||
self._set_property("type", arg, type)
|
||||
self._set_property("value", arg, value)
|
||||
self._set_property("valueminus", arg, valueminus)
|
||||
self._set_property("visible", arg, visible)
|
||||
self._set_property("width", arg, width)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,480 @@
|
||||
# --- 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 ErrorY(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.error_y"
|
||||
_valid_props = {
|
||||
"array",
|
||||
"arrayminus",
|
||||
"arrayminussrc",
|
||||
"arraysrc",
|
||||
"color",
|
||||
"symmetric",
|
||||
"thickness",
|
||||
"traceref",
|
||||
"tracerefminus",
|
||||
"type",
|
||||
"value",
|
||||
"valueminus",
|
||||
"visible",
|
||||
"width",
|
||||
}
|
||||
|
||||
@property
|
||||
def array(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar.
|
||||
Values are plotted relative to the underlying data.
|
||||
|
||||
The 'array' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["array"]
|
||||
|
||||
@array.setter
|
||||
def array(self, val):
|
||||
self["array"] = val
|
||||
|
||||
@property
|
||||
def arrayminus(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar in the
|
||||
bottom (left) direction for vertical (horizontal) bars Values
|
||||
are plotted relative to the underlying data.
|
||||
|
||||
The 'arrayminus' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["arrayminus"]
|
||||
|
||||
@arrayminus.setter
|
||||
def arrayminus(self, val):
|
||||
self["arrayminus"] = val
|
||||
|
||||
@property
|
||||
def arrayminussrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
|
||||
The 'arrayminussrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arrayminussrc"]
|
||||
|
||||
@arrayminussrc.setter
|
||||
def arrayminussrc(self, val):
|
||||
self["arrayminussrc"] = val
|
||||
|
||||
@property
|
||||
def arraysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `array`.
|
||||
|
||||
The 'arraysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arraysrc"]
|
||||
|
||||
@arraysrc.setter
|
||||
def arraysrc(self, val):
|
||||
self["arraysrc"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the stroke color of the error bars.
|
||||
|
||||
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 symmetric(self):
|
||||
"""
|
||||
Determines whether or not the error bars have the same length
|
||||
in both direction (top/bottom for vertical bars, left/right for
|
||||
horizontal bars.
|
||||
|
||||
The 'symmetric' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["symmetric"]
|
||||
|
||||
@symmetric.setter
|
||||
def symmetric(self, val):
|
||||
self["symmetric"] = val
|
||||
|
||||
@property
|
||||
def thickness(self):
|
||||
"""
|
||||
Sets the thickness (in px) of the error bars.
|
||||
|
||||
The 'thickness' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["thickness"]
|
||||
|
||||
@thickness.setter
|
||||
def thickness(self, val):
|
||||
self["thickness"] = val
|
||||
|
||||
@property
|
||||
def traceref(self):
|
||||
"""
|
||||
The 'traceref' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["traceref"]
|
||||
|
||||
@traceref.setter
|
||||
def traceref(self, val):
|
||||
self["traceref"] = val
|
||||
|
||||
@property
|
||||
def tracerefminus(self):
|
||||
"""
|
||||
The 'tracerefminus' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["tracerefminus"]
|
||||
|
||||
@tracerefminus.setter
|
||||
def tracerefminus(self, val):
|
||||
self["tracerefminus"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
"""
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value. Set this
|
||||
constant in `value`. If "percent", the bar lengths correspond
|
||||
to a percentage of underlying data. Set this percentage in
|
||||
`value`. If "sqrt", the bar lengths correspond to the square of
|
||||
the underlying data. If "data", the bar lengths are set with
|
||||
data set `array`.
|
||||
|
||||
The 'type' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['percent', 'constant', 'sqrt', 'data']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["type"]
|
||||
|
||||
@type.setter
|
||||
def type(self, val):
|
||||
self["type"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars.
|
||||
|
||||
The 'value' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def valueminus(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars in the bottom
|
||||
(left) direction for vertical (horizontal) bars
|
||||
|
||||
The 'valueminus' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["valueminus"]
|
||||
|
||||
@valueminus.setter
|
||||
def valueminus(self, val):
|
||||
self["valueminus"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this set of error bars is visible.
|
||||
|
||||
The 'visible' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the cross-bar at both ends of the
|
||||
error bars.
|
||||
|
||||
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 """\
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
array=None,
|
||||
arrayminus=None,
|
||||
arrayminussrc=None,
|
||||
arraysrc=None,
|
||||
color=None,
|
||||
symmetric=None,
|
||||
thickness=None,
|
||||
traceref=None,
|
||||
tracerefminus=None,
|
||||
type=None,
|
||||
value=None,
|
||||
valueminus=None,
|
||||
visible=None,
|
||||
width=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new ErrorY object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.ErrorY`
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ErrorY
|
||||
"""
|
||||
super().__init__("error_y")
|
||||
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.histogram.ErrorY
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.ErrorY`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("array", arg, array)
|
||||
self._set_property("arrayminus", arg, arrayminus)
|
||||
self._set_property("arrayminussrc", arg, arrayminussrc)
|
||||
self._set_property("arraysrc", arg, arraysrc)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("symmetric", arg, symmetric)
|
||||
self._set_property("thickness", arg, thickness)
|
||||
self._set_property("traceref", arg, traceref)
|
||||
self._set_property("tracerefminus", arg, tracerefminus)
|
||||
self._set_property("type", arg, type)
|
||||
self._set_property("value", arg, value)
|
||||
self._set_property("valueminus", arg, valueminus)
|
||||
self._set_property("visible", arg, visible)
|
||||
self._set_property("width", arg, width)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,366 @@
|
||||
# --- 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 = "histogram"
|
||||
_path_str = "histogram.hoverlabel"
|
||||
_valid_props = {
|
||||
"align",
|
||||
"alignsrc",
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"bordercolor",
|
||||
"bordercolorsrc",
|
||||
"font",
|
||||
"namelength",
|
||||
"namelengthsrc",
|
||||
"showarrow",
|
||||
}
|
||||
|
||||
@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.histogram.hoverlabel.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.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 showarrow(self):
|
||||
"""
|
||||
Sets whether or not to show the hover label arrow/triangle
|
||||
pointing to the data point.
|
||||
|
||||
The 'showarrow' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showarrow"]
|
||||
|
||||
@showarrow.setter
|
||||
def showarrow(self, val):
|
||||
self["showarrow"] = 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`.
|
||||
showarrow
|
||||
Sets whether or not to show the hover label
|
||||
arrow/triangle pointing to the data point.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
align=None,
|
||||
alignsrc=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
bordercolor=None,
|
||||
bordercolorsrc=None,
|
||||
font=None,
|
||||
namelength=None,
|
||||
namelengthsrc=None,
|
||||
showarrow=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Hoverlabel object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.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`.
|
||||
showarrow
|
||||
Sets whether or not to show the hover label
|
||||
arrow/triangle pointing to the data point.
|
||||
|
||||
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.histogram.Hoverlabel
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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._set_property("showarrow", arg, showarrow)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -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 Insidetextfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.insidetextfont"
|
||||
_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 Insidetextfont object
|
||||
|
||||
Sets the font used for `text` lying inside the bar.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.Insidetextfont`
|
||||
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
|
||||
-------
|
||||
Insidetextfont
|
||||
"""
|
||||
super().__init__("insidetextfont")
|
||||
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.histogram.Insidetextfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.Insidetextfont`""")
|
||||
|
||||
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,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 = "histogram"
|
||||
_path_str = "histogram.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.histogram.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.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.histogram.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.histogram.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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,686 @@
|
||||
# --- 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 = "histogram"
|
||||
_path_str = "histogram.marker"
|
||||
_valid_props = {
|
||||
"autocolorscale",
|
||||
"cauto",
|
||||
"cmax",
|
||||
"cmid",
|
||||
"cmin",
|
||||
"color",
|
||||
"coloraxis",
|
||||
"colorbar",
|
||||
"colorscale",
|
||||
"colorsrc",
|
||||
"cornerradius",
|
||||
"line",
|
||||
"opacity",
|
||||
"opacitysrc",
|
||||
"pattern",
|
||||
"reversescale",
|
||||
"showscale",
|
||||
}
|
||||
|
||||
@property
|
||||
def autocolorscale(self):
|
||||
"""
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. In case `colorscale` is unspecified
|
||||
or `autocolorscale` is true, the default palette will be chosen
|
||||
according to whether numbers in the `color` array are all
|
||||
positive, all negative or mixed.
|
||||
|
||||
The 'autocolorscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["autocolorscale"]
|
||||
|
||||
@autocolorscale.setter
|
||||
def autocolorscale(self, val):
|
||||
self["autocolorscale"] = val
|
||||
|
||||
@property
|
||||
def cauto(self):
|
||||
"""
|
||||
Determines whether or not the color domain is computed with
|
||||
respect to the input data (here in `marker.color`) or the
|
||||
bounds set in `marker.cmin` and `marker.cmax` Has an effect
|
||||
only if in `marker.color` is set to a numerical array. Defaults
|
||||
to `false` when `marker.cmin` and `marker.cmax` are set by the
|
||||
user.
|
||||
|
||||
The 'cauto' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["cauto"]
|
||||
|
||||
@cauto.setter
|
||||
def cauto(self, val):
|
||||
self["cauto"] = val
|
||||
|
||||
@property
|
||||
def cmax(self):
|
||||
"""
|
||||
Sets the upper bound of the color domain. Has an effect only if
|
||||
in `marker.color` is set to a numerical array. Value should
|
||||
have the same units as in `marker.color` and if set,
|
||||
`marker.cmin` must be set as well.
|
||||
|
||||
The 'cmax' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmax"]
|
||||
|
||||
@cmax.setter
|
||||
def cmax(self, val):
|
||||
self["cmax"] = val
|
||||
|
||||
@property
|
||||
def cmid(self):
|
||||
"""
|
||||
Sets the mid-point of the color domain by scaling `marker.cmin`
|
||||
and/or `marker.cmax` to be equidistant to this point. Has an
|
||||
effect only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`. Has no
|
||||
effect when `marker.cauto` is `false`.
|
||||
|
||||
The 'cmid' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmid"]
|
||||
|
||||
@cmid.setter
|
||||
def cmid(self, val):
|
||||
self["cmid"] = val
|
||||
|
||||
@property
|
||||
def cmin(self):
|
||||
"""
|
||||
Sets the lower bound of the color domain. Has an effect only if
|
||||
in `marker.color` is set to a numerical array. Value should
|
||||
have the same units as in `marker.color` and if set,
|
||||
`marker.cmax` must be set as well.
|
||||
|
||||
The 'cmin' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmin"]
|
||||
|
||||
@cmin.setter
|
||||
def cmin(self, val):
|
||||
self["cmin"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color. It accepts either a specific color or an
|
||||
array of numbers that are mapped to the colorscale relative to
|
||||
the max and min values of the array or relative to
|
||||
`marker.cmin` and `marker.cmax` if set.
|
||||
|
||||
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 number that will be interpreted as a color
|
||||
according to histogram.marker.colorscale
|
||||
- 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 coloraxis(self):
|
||||
"""
|
||||
Sets a reference to a shared color axis. References to these
|
||||
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
|
||||
etc. Settings for these shared color axes are set in the
|
||||
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
|
||||
Note that multiple color scales can be linked to the same color
|
||||
axis.
|
||||
|
||||
The 'coloraxis' property is an identifier of a particular
|
||||
subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["coloraxis"]
|
||||
|
||||
@coloraxis.setter
|
||||
def coloraxis(self, val):
|
||||
self["coloraxis"] = val
|
||||
|
||||
@property
|
||||
def colorbar(self):
|
||||
"""
|
||||
The 'colorbar' property is an instance of ColorBar
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.marker.ColorBar`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the ColorBar constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.marker.ColorBar
|
||||
"""
|
||||
return self["colorbar"]
|
||||
|
||||
@colorbar.setter
|
||||
def colorbar(self, val):
|
||||
self["colorbar"] = val
|
||||
|
||||
@property
|
||||
def colorscale(self):
|
||||
"""
|
||||
Sets the colorscale. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. The colorscale must be an array
|
||||
containing arrays mapping a normalized value to an rgb, rgba,
|
||||
hex, hsl, hsv, or named color string. At minimum, a mapping for
|
||||
the lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To
|
||||
control the bounds of the colorscale in color space, use
|
||||
`marker.cmin` and `marker.cmax`. Alternatively, `colorscale`
|
||||
may be a palette name string of the following list: Blackbody,B
|
||||
luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic
|
||||
,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
|
||||
The 'colorscale' property is a colorscale and may be
|
||||
specified as:
|
||||
- A list of colors that will be spaced evenly to create the colorscale.
|
||||
Many predefined colorscale lists are included in the sequential, diverging,
|
||||
and cyclical modules in the plotly.colors package.
|
||||
- A list of 2-element lists where the first element is the
|
||||
normalized color level value (starting at 0 and ending at 1),
|
||||
and the second item is a valid color string.
|
||||
(e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
|
||||
- One of the following named colorscales:
|
||||
['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
|
||||
'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
|
||||
'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
|
||||
'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
|
||||
'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
|
||||
'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
|
||||
'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
|
||||
'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
|
||||
'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
|
||||
'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
|
||||
'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
|
||||
'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
|
||||
'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
|
||||
'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
|
||||
'ylorrd'].
|
||||
Appending '_r' to a named colorscale reverses it.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorscale"]
|
||||
|
||||
@colorscale.setter
|
||||
def colorscale(self, val):
|
||||
self["colorscale"] = 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 cornerradius(self):
|
||||
"""
|
||||
Sets the rounding of corners. May be an integer number of
|
||||
pixels, or a percentage of bar width (as a string ending in %).
|
||||
Defaults to `layout.barcornerradius`. In stack or relative
|
||||
barmode, the first trace to set cornerradius is used for the
|
||||
whole stack.
|
||||
|
||||
The 'cornerradius' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["cornerradius"]
|
||||
|
||||
@cornerradius.setter
|
||||
def cornerradius(self, val):
|
||||
self["cornerradius"] = val
|
||||
|
||||
@property
|
||||
def line(self):
|
||||
"""
|
||||
The 'line' property is an instance of Line
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.marker.Line`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Line constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.marker.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
@property
|
||||
def opacity(self):
|
||||
"""
|
||||
Sets the opacity of the bars.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def opacitysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `opacity`.
|
||||
|
||||
The 'opacitysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["opacitysrc"]
|
||||
|
||||
@opacitysrc.setter
|
||||
def opacitysrc(self, val):
|
||||
self["opacitysrc"] = val
|
||||
|
||||
@property
|
||||
def pattern(self):
|
||||
"""
|
||||
Sets the pattern within the marker.
|
||||
|
||||
The 'pattern' property is an instance of Pattern
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.marker.Pattern`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Pattern constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.marker.Pattern
|
||||
"""
|
||||
return self["pattern"]
|
||||
|
||||
@pattern.setter
|
||||
def pattern(self, val):
|
||||
self["pattern"] = val
|
||||
|
||||
@property
|
||||
def reversescale(self):
|
||||
"""
|
||||
Reverses the color mapping if true. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. If true,
|
||||
`marker.cmin` will correspond to the last color in the array
|
||||
and `marker.cmax` will correspond to the first color.
|
||||
|
||||
The 'reversescale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["reversescale"]
|
||||
|
||||
@reversescale.setter
|
||||
def reversescale(self, val):
|
||||
self["reversescale"] = val
|
||||
|
||||
@property
|
||||
def showscale(self):
|
||||
"""
|
||||
Determines whether or not a colorbar is displayed for this
|
||||
trace. Has an effect only if in `marker.color` is set to a
|
||||
numerical array.
|
||||
|
||||
The 'showscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showscale"]
|
||||
|
||||
@showscale.setter
|
||||
def showscale(self, val):
|
||||
self["showscale"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in `marker.color`)
|
||||
or the bounds set in `marker.cmin` and `marker.cmax`
|
||||
Has an effect only if in `marker.color` is set to a
|
||||
numerical array. Defaults to `false` when `marker.cmin`
|
||||
and `marker.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.cmin` and/or `marker.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `marker.color`. Has no effect when
|
||||
`marker.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmax` must be set as well.
|
||||
color
|
||||
Sets the marker color. It accepts either a specific
|
||||
color or an array of numbers that are mapped to the
|
||||
colorscale relative to the max and min values of the
|
||||
array or relative to `marker.cmin` and `marker.cmax` if
|
||||
set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.histogram.marker.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.cmin` and `marker.cmax`. Alternatively,
|
||||
`colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,E
|
||||
lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
||||
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
cornerradius
|
||||
Sets the rounding of corners. May be an integer number
|
||||
of pixels, or a percentage of bar width (as a string
|
||||
ending in %). Defaults to `layout.barcornerradius`. In
|
||||
stack or relative barmode, the first trace to set
|
||||
cornerradius is used for the whole stack.
|
||||
line
|
||||
:class:`plotly.graph_objects.histogram.marker.Line`
|
||||
instance or dict with compatible properties
|
||||
opacity
|
||||
Sets the opacity of the bars.
|
||||
opacitysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`opacity`.
|
||||
pattern
|
||||
Sets the pattern within the marker.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.color` is set to a numerical array. If
|
||||
true, `marker.cmin` will correspond to the last color
|
||||
in the array and `marker.cmax` will correspond to the
|
||||
first color.
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `marker.color` is
|
||||
set to a numerical array.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
autocolorscale=None,
|
||||
cauto=None,
|
||||
cmax=None,
|
||||
cmid=None,
|
||||
cmin=None,
|
||||
color=None,
|
||||
coloraxis=None,
|
||||
colorbar=None,
|
||||
colorscale=None,
|
||||
colorsrc=None,
|
||||
cornerradius=None,
|
||||
line=None,
|
||||
opacity=None,
|
||||
opacitysrc=None,
|
||||
pattern=None,
|
||||
reversescale=None,
|
||||
showscale=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.Marker`
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in `marker.color`)
|
||||
or the bounds set in `marker.cmin` and `marker.cmax`
|
||||
Has an effect only if in `marker.color` is set to a
|
||||
numerical array. Defaults to `false` when `marker.cmin`
|
||||
and `marker.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.cmin` and/or `marker.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `marker.color`. Has no effect when
|
||||
`marker.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmax` must be set as well.
|
||||
color
|
||||
Sets the marker color. It accepts either a specific
|
||||
color or an array of numbers that are mapped to the
|
||||
colorscale relative to the max and min values of the
|
||||
array or relative to `marker.cmin` and `marker.cmax` if
|
||||
set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.histogram.marker.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.cmin` and `marker.cmax`. Alternatively,
|
||||
`colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,E
|
||||
lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
||||
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
cornerradius
|
||||
Sets the rounding of corners. May be an integer number
|
||||
of pixels, or a percentage of bar width (as a string
|
||||
ending in %). Defaults to `layout.barcornerradius`. In
|
||||
stack or relative barmode, the first trace to set
|
||||
cornerradius is used for the whole stack.
|
||||
line
|
||||
:class:`plotly.graph_objects.histogram.marker.Line`
|
||||
instance or dict with compatible properties
|
||||
opacity
|
||||
Sets the opacity of the bars.
|
||||
opacitysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`opacity`.
|
||||
pattern
|
||||
Sets the pattern within the marker.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.color` is set to a numerical array. If
|
||||
true, `marker.cmin` will correspond to the last color
|
||||
in the array and `marker.cmax` will correspond to the
|
||||
first color.
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `marker.color` is
|
||||
set to a numerical array.
|
||||
|
||||
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.histogram.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("autocolorscale", arg, autocolorscale)
|
||||
self._set_property("cauto", arg, cauto)
|
||||
self._set_property("cmax", arg, cmax)
|
||||
self._set_property("cmid", arg, cmid)
|
||||
self._set_property("cmin", arg, cmin)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("coloraxis", arg, coloraxis)
|
||||
self._set_property("colorbar", arg, colorbar)
|
||||
self._set_property("colorscale", arg, colorscale)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("cornerradius", arg, cornerradius)
|
||||
self._set_property("line", arg, line)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._set_property("opacitysrc", arg, opacitysrc)
|
||||
self._set_property("pattern", arg, pattern)
|
||||
self._set_property("reversescale", arg, reversescale)
|
||||
self._set_property("showscale", arg, showscale)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -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 Outsidetextfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.outsidetextfont"
|
||||
_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 Outsidetextfont object
|
||||
|
||||
Sets the font used for `text` lying outside the bar.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.Outsidetextfont`
|
||||
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
|
||||
-------
|
||||
Outsidetextfont
|
||||
"""
|
||||
super().__init__("outsidetextfont")
|
||||
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.histogram.Outsidetextfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.Outsidetextfont`""")
|
||||
|
||||
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,106 @@
|
||||
# --- 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 Selected(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.selected"
|
||||
_valid_props = {"marker", "textfont"}
|
||||
|
||||
@property
|
||||
def marker(self):
|
||||
"""
|
||||
The 'marker' property is an instance of Marker
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.selected.Marker`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Marker constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.selected.Marker
|
||||
"""
|
||||
return self["marker"]
|
||||
|
||||
@marker.setter
|
||||
def marker(self, val):
|
||||
self["marker"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.selected.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.selected.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
marker
|
||||
:class:`plotly.graph_objects.histogram.selected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.histogram.selected.Textfon
|
||||
t` instance or dict with compatible properties
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
|
||||
"""
|
||||
Construct a new Selected object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.Selected`
|
||||
marker
|
||||
:class:`plotly.graph_objects.histogram.selected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.histogram.selected.Textfon
|
||||
t` instance or dict with compatible properties
|
||||
|
||||
Returns
|
||||
-------
|
||||
Selected
|
||||
"""
|
||||
super().__init__("selected")
|
||||
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.histogram.Selected
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.Selected`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("marker", arg, marker)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
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 = "histogram"
|
||||
_path_str = "histogram.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.histogram.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.histogram.Stream
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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,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 Textfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.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
|
||||
|
||||
Sets the text font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.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.histogram.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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,106 @@
|
||||
# --- 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 Unselected(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram"
|
||||
_path_str = "histogram.unselected"
|
||||
_valid_props = {"marker", "textfont"}
|
||||
|
||||
@property
|
||||
def marker(self):
|
||||
"""
|
||||
The 'marker' property is an instance of Marker
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.unselected.Marker`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Marker constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.unselected.Marker
|
||||
"""
|
||||
return self["marker"]
|
||||
|
||||
@marker.setter
|
||||
def marker(self, val):
|
||||
self["marker"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.histogram.unselected.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.unselected.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
marker
|
||||
:class:`plotly.graph_objects.histogram.unselected.Marke
|
||||
r` instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.histogram.unselected.Textf
|
||||
ont` instance or dict with compatible properties
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
|
||||
"""
|
||||
Construct a new Unselected object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.Unselected`
|
||||
marker
|
||||
:class:`plotly.graph_objects.histogram.unselected.Marke
|
||||
r` instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.histogram.unselected.Textf
|
||||
ont` instance or dict with compatible properties
|
||||
|
||||
Returns
|
||||
-------
|
||||
Unselected
|
||||
"""
|
||||
super().__init__("unselected")
|
||||
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.histogram.Unselected
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.Unselected`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("marker", arg, marker)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,210 @@
|
||||
# --- 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 = "histogram"
|
||||
_path_str = "histogram.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). If multiple non-overlaying
|
||||
histograms share a subplot, the first explicit `size` is used
|
||||
and all others discarded. If no `size` is provided,the sample
|
||||
data from all traces is combined to determine `size` as
|
||||
described above.
|
||||
|
||||
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. If multiple non-overlaying
|
||||
histograms share a subplot, the first explicit `start` is used
|
||||
exactly and all others are shifted down (if necessary) to
|
||||
differ from that one by an integer number of bins.
|
||||
|
||||
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). If multiple non-
|
||||
overlaying histograms share a subplot, the first
|
||||
explicit `size` is used and all others discarded. If no
|
||||
`size` is provided,the sample data from all traces is
|
||||
combined to determine `size` as described above.
|
||||
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. If
|
||||
multiple non-overlaying histograms share a subplot, the
|
||||
first explicit `start` is used exactly and all others
|
||||
are shifted down (if necessary) to differ from that one
|
||||
by an integer number of bins.
|
||||
"""
|
||||
|
||||
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.histogram.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). If multiple non-
|
||||
overlaying histograms share a subplot, the first
|
||||
explicit `size` is used and all others discarded. If no
|
||||
`size` is provided,the sample data from all traces is
|
||||
combined to determine `size` as described above.
|
||||
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. If
|
||||
multiple non-overlaying histograms share a subplot, the
|
||||
first explicit `start` is used exactly and all others
|
||||
are shifted down (if necessary) to differ from that one
|
||||
by an integer number of bins.
|
||||
|
||||
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.histogram.XBins
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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,210 @@
|
||||
# --- 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 = "histogram"
|
||||
_path_str = "histogram.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). If multiple non-overlaying
|
||||
histograms share a subplot, the first explicit `size` is used
|
||||
and all others discarded. If no `size` is provided,the sample
|
||||
data from all traces is combined to determine `size` as
|
||||
described above.
|
||||
|
||||
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. If multiple non-overlaying
|
||||
histograms share a subplot, the first explicit `start` is used
|
||||
exactly and all others are shifted down (if necessary) to
|
||||
differ from that one by an integer number of bins.
|
||||
|
||||
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). If multiple non-
|
||||
overlaying histograms share a subplot, the first
|
||||
explicit `size` is used and all others discarded. If no
|
||||
`size` is provided,the sample data from all traces is
|
||||
combined to determine `size` as described above.
|
||||
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. If
|
||||
multiple non-overlaying histograms share a subplot, the
|
||||
first explicit `start` is used exactly and all others
|
||||
are shifted down (if necessary) to differ from that one
|
||||
by an integer number of bins.
|
||||
"""
|
||||
|
||||
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.histogram.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). If multiple non-
|
||||
overlaying histograms share a subplot, the first
|
||||
explicit `size` is used and all others discarded. If no
|
||||
`size` is provided,the sample data from all traces is
|
||||
combined to determine `size` as described above.
|
||||
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. If
|
||||
multiple non-overlaying histograms share a subplot, the
|
||||
first explicit `start` is used exactly and all others
|
||||
are shifted down (if necessary) to differ from that one
|
||||
by an integer number of bins.
|
||||
|
||||
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.histogram.YBins
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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,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"])
|
@ -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 = "histogram.hoverlabel"
|
||||
_path_str = "histogram.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.histogram.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.histogram.hoverlabel.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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"])
|
@ -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 = "histogram.legendgrouptitle"
|
||||
_path_str = "histogram.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.histogram.lege
|
||||
ndgrouptitle.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.histogram.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.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
|
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._colorbar import ColorBar
|
||||
from ._line import Line
|
||||
from ._pattern import Pattern
|
||||
from . import colorbar
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".colorbar"],
|
||||
["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"],
|
||||
)
|
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,546 @@
|
||||
# --- 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 = "histogram.marker"
|
||||
_path_str = "histogram.marker.line"
|
||||
_valid_props = {
|
||||
"autocolorscale",
|
||||
"cauto",
|
||||
"cmax",
|
||||
"cmid",
|
||||
"cmin",
|
||||
"color",
|
||||
"coloraxis",
|
||||
"colorscale",
|
||||
"colorsrc",
|
||||
"reversescale",
|
||||
"width",
|
||||
"widthsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def autocolorscale(self):
|
||||
"""
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.line.colorscale`. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is true, the
|
||||
default palette will be chosen according to whether numbers in
|
||||
the `color` array are all positive, all negative or mixed.
|
||||
|
||||
The 'autocolorscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["autocolorscale"]
|
||||
|
||||
@autocolorscale.setter
|
||||
def autocolorscale(self, val):
|
||||
self["autocolorscale"] = val
|
||||
|
||||
@property
|
||||
def cauto(self):
|
||||
"""
|
||||
Determines whether or not the color domain is computed with
|
||||
respect to the input data (here in `marker.line.color`) or the
|
||||
bounds set in `marker.line.cmin` and `marker.line.cmax` Has an
|
||||
effect only if in `marker.line.color` is set to a numerical
|
||||
array. Defaults to `false` when `marker.line.cmin` and
|
||||
`marker.line.cmax` are set by the user.
|
||||
|
||||
The 'cauto' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["cauto"]
|
||||
|
||||
@cauto.setter
|
||||
def cauto(self, val):
|
||||
self["cauto"] = val
|
||||
|
||||
@property
|
||||
def cmax(self):
|
||||
"""
|
||||
Sets the upper bound of the color domain. Has an effect only if
|
||||
in `marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color` and if
|
||||
set, `marker.line.cmin` must be set as well.
|
||||
|
||||
The 'cmax' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmax"]
|
||||
|
||||
@cmax.setter
|
||||
def cmax(self, val):
|
||||
self["cmax"] = val
|
||||
|
||||
@property
|
||||
def cmid(self):
|
||||
"""
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.line.cmin` and/or `marker.line.cmax` to be equidistant
|
||||
to this point. Has an effect only if in `marker.line.color` is
|
||||
set to a numerical array. Value should have the same units as
|
||||
in `marker.line.color`. Has no effect when `marker.line.cauto`
|
||||
is `false`.
|
||||
|
||||
The 'cmid' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmid"]
|
||||
|
||||
@cmid.setter
|
||||
def cmid(self, val):
|
||||
self["cmid"] = val
|
||||
|
||||
@property
|
||||
def cmin(self):
|
||||
"""
|
||||
Sets the lower bound of the color domain. Has an effect only if
|
||||
in `marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color` and if
|
||||
set, `marker.line.cmax` must be set as well.
|
||||
|
||||
The 'cmin' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmin"]
|
||||
|
||||
@cmin.setter
|
||||
def cmin(self, val):
|
||||
self["cmin"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker.line color. It accepts either a specific color
|
||||
or an array of numbers that are mapped to the colorscale
|
||||
relative to the max and min values of the array or relative to
|
||||
`marker.line.cmin` and `marker.line.cmax` if set.
|
||||
|
||||
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 number that will be interpreted as a color
|
||||
according to histogram.marker.line.colorscale
|
||||
- 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 coloraxis(self):
|
||||
"""
|
||||
Sets a reference to a shared color axis. References to these
|
||||
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
|
||||
etc. Settings for these shared color axes are set in the
|
||||
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
|
||||
Note that multiple color scales can be linked to the same color
|
||||
axis.
|
||||
|
||||
The 'coloraxis' property is an identifier of a particular
|
||||
subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["coloraxis"]
|
||||
|
||||
@coloraxis.setter
|
||||
def coloraxis(self, val):
|
||||
self["coloraxis"] = val
|
||||
|
||||
@property
|
||||
def colorscale(self):
|
||||
"""
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. The colorscale
|
||||
must be an array containing arrays mapping a normalized value
|
||||
to an rgb, rgba, hex, hsl, hsv, or named color string. At
|
||||
minimum, a mapping for the lowest (0) and highest (1) values
|
||||
are required. For example, `[[0, 'rgb(0,0,255)'], [1,
|
||||
'rgb(255,0,0)']]`. To control the bounds of the colorscale in
|
||||
color space, use `marker.line.cmin` and `marker.line.cmax`.
|
||||
Alternatively, `colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
|
||||
Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
|
||||
YlGnBu,YlOrRd.
|
||||
|
||||
The 'colorscale' property is a colorscale and may be
|
||||
specified as:
|
||||
- A list of colors that will be spaced evenly to create the colorscale.
|
||||
Many predefined colorscale lists are included in the sequential, diverging,
|
||||
and cyclical modules in the plotly.colors package.
|
||||
- A list of 2-element lists where the first element is the
|
||||
normalized color level value (starting at 0 and ending at 1),
|
||||
and the second item is a valid color string.
|
||||
(e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
|
||||
- One of the following named colorscales:
|
||||
['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
|
||||
'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
|
||||
'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
|
||||
'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
|
||||
'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
|
||||
'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
|
||||
'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
|
||||
'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
|
||||
'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
|
||||
'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
|
||||
'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
|
||||
'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
|
||||
'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
|
||||
'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
|
||||
'ylorrd'].
|
||||
Appending '_r' to a named colorscale reverses it.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorscale"]
|
||||
|
||||
@colorscale.setter
|
||||
def colorscale(self, val):
|
||||
self["colorscale"] = 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 reversescale(self):
|
||||
"""
|
||||
Reverses the color mapping if true. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. If true,
|
||||
`marker.line.cmin` will correspond to the last color in the
|
||||
array and `marker.line.cmax` will correspond to the first
|
||||
color.
|
||||
|
||||
The 'reversescale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["reversescale"]
|
||||
|
||||
@reversescale.setter
|
||||
def reversescale(self, val):
|
||||
self["reversescale"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the lines bounding the marker points.
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def widthsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `width`.
|
||||
|
||||
The 'widthsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["widthsrc"]
|
||||
|
||||
@widthsrc.setter
|
||||
def widthsrc(self, val):
|
||||
self["widthsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.line.colorscale`. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. In
|
||||
case `colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in
|
||||
`marker.line.color`) or the bounds set in
|
||||
`marker.line.cmin` and `marker.line.cmax` Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Defaults to `false` when `marker.line.cmin` and
|
||||
`marker.line.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmin` must
|
||||
be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.line.cmin` and/or `marker.line.cmax` to be
|
||||
equidistant to this point. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color`.
|
||||
Has no effect when `marker.line.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmax` must
|
||||
be set as well.
|
||||
color
|
||||
Sets the marker.line color. It accepts either a
|
||||
specific color or an array of numbers that are mapped
|
||||
to the colorscale relative to the max and min values of
|
||||
the array or relative to `marker.line.cmin` and
|
||||
`marker.line.cmax` if set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.line.cmin` and `marker.line.cmax`.
|
||||
Alternatively, `colorscale` may be a palette name
|
||||
string of the following list: Blackbody,Bluered,Blues,C
|
||||
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
|
||||
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.line.color` is set to a numerical array.
|
||||
If true, `marker.line.cmin` will correspond to the last
|
||||
color in the array and `marker.line.cmax` will
|
||||
correspond to the first color.
|
||||
width
|
||||
Sets the width (in px) of the lines bounding the marker
|
||||
points.
|
||||
widthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`width`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
autocolorscale=None,
|
||||
cauto=None,
|
||||
cmax=None,
|
||||
cmid=None,
|
||||
cmin=None,
|
||||
color=None,
|
||||
coloraxis=None,
|
||||
colorscale=None,
|
||||
colorsrc=None,
|
||||
reversescale=None,
|
||||
width=None,
|
||||
widthsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Line object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.marker.Line`
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.line.colorscale`. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. In
|
||||
case `colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in
|
||||
`marker.line.color`) or the bounds set in
|
||||
`marker.line.cmin` and `marker.line.cmax` Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Defaults to `false` when `marker.line.cmin` and
|
||||
`marker.line.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmin` must
|
||||
be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.line.cmin` and/or `marker.line.cmax` to be
|
||||
equidistant to this point. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color`.
|
||||
Has no effect when `marker.line.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmax` must
|
||||
be set as well.
|
||||
color
|
||||
Sets the marker.line color. It accepts either a
|
||||
specific color or an array of numbers that are mapped
|
||||
to the colorscale relative to the max and min values of
|
||||
the array or relative to `marker.line.cmin` and
|
||||
`marker.line.cmax` if set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.line.cmin` and `marker.line.cmax`.
|
||||
Alternatively, `colorscale` may be a palette name
|
||||
string of the following list: Blackbody,Bluered,Blues,C
|
||||
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
|
||||
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.line.color` is set to a numerical array.
|
||||
If true, `marker.line.cmin` will correspond to the last
|
||||
color in the array and `marker.line.cmax` will
|
||||
correspond to the first color.
|
||||
width
|
||||
Sets the width (in px) of the lines bounding the marker
|
||||
points.
|
||||
widthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`width`.
|
||||
|
||||
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.histogram.marker.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.marker.Line`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("autocolorscale", arg, autocolorscale)
|
||||
self._set_property("cauto", arg, cauto)
|
||||
self._set_property("cmax", arg, cmax)
|
||||
self._set_property("cmid", arg, cmid)
|
||||
self._set_property("cmin", arg, cmin)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("coloraxis", arg, coloraxis)
|
||||
self._set_property("colorscale", arg, colorscale)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("reversescale", arg, reversescale)
|
||||
self._set_property("width", arg, width)
|
||||
self._set_property("widthsrc", arg, widthsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,495 @@
|
||||
# --- 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 Pattern(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram.marker"
|
||||
_path_str = "histogram.marker.pattern"
|
||||
_valid_props = {
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"fgcolor",
|
||||
"fgcolorsrc",
|
||||
"fgopacity",
|
||||
"fillmode",
|
||||
"path",
|
||||
"pathsrc",
|
||||
"shape",
|
||||
"shapesrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"solidity",
|
||||
"soliditysrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def bgcolor(self):
|
||||
"""
|
||||
When there is no colorscale sets the color of background
|
||||
pattern fill. Defaults to a `marker.color` background when
|
||||
`fillmode` is "overlay". Otherwise, defaults to a transparent
|
||||
background.
|
||||
|
||||
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 fgcolor(self):
|
||||
"""
|
||||
When there is no colorscale sets the color of foreground
|
||||
pattern fill. Defaults to a `marker.color` background when
|
||||
`fillmode` is "replace". Otherwise, defaults to dark grey or
|
||||
white to increase contrast with the `bgcolor`.
|
||||
|
||||
The 'fgcolor' 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["fgcolor"]
|
||||
|
||||
@fgcolor.setter
|
||||
def fgcolor(self, val):
|
||||
self["fgcolor"] = val
|
||||
|
||||
@property
|
||||
def fgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `fgcolor`.
|
||||
|
||||
The 'fgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["fgcolorsrc"]
|
||||
|
||||
@fgcolorsrc.setter
|
||||
def fgcolorsrc(self, val):
|
||||
self["fgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def fgopacity(self):
|
||||
"""
|
||||
Sets the opacity of the foreground pattern fill. Defaults to a
|
||||
0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
|
||||
|
||||
The 'fgopacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["fgopacity"]
|
||||
|
||||
@fgopacity.setter
|
||||
def fgopacity(self, val):
|
||||
self["fgopacity"] = val
|
||||
|
||||
@property
|
||||
def fillmode(self):
|
||||
"""
|
||||
Determines whether `marker.color` should be used as a default
|
||||
to `bgcolor` or a `fgcolor`.
|
||||
|
||||
The 'fillmode' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['replace', 'overlay']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["fillmode"]
|
||||
|
||||
@fillmode.setter
|
||||
def fillmode(self, val):
|
||||
self["fillmode"] = val
|
||||
|
||||
@property
|
||||
def path(self):
|
||||
"""
|
||||
Sets a custom path for pattern fill. Use with no `shape` or
|
||||
`solidity`, provide an SVG path string for the regions of the
|
||||
square from (0,0) to (`size`,`size`) to color.
|
||||
|
||||
The 'path' 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["path"]
|
||||
|
||||
@path.setter
|
||||
def path(self, val):
|
||||
self["path"] = val
|
||||
|
||||
@property
|
||||
def pathsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `path`.
|
||||
|
||||
The 'pathsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["pathsrc"]
|
||||
|
||||
@pathsrc.setter
|
||||
def pathsrc(self, val):
|
||||
self["pathsrc"] = val
|
||||
|
||||
@property
|
||||
def shape(self):
|
||||
"""
|
||||
Sets the shape of the pattern fill. By default, no pattern is
|
||||
used for filling the area.
|
||||
|
||||
The 'shape' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['', '/', '\\', 'x', '-', '|', '+', '.']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["shape"]
|
||||
|
||||
@shape.setter
|
||||
def shape(self, val):
|
||||
self["shape"] = val
|
||||
|
||||
@property
|
||||
def shapesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shape`.
|
||||
|
||||
The 'shapesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shapesrc"]
|
||||
|
||||
@shapesrc.setter
|
||||
def shapesrc(self, val):
|
||||
self["shapesrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
Sets the size of unit squares of the pattern fill in pixels,
|
||||
which corresponds to the interval of repetition of the pattern.
|
||||
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 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 solidity(self):
|
||||
"""
|
||||
Sets the solidity of the pattern fill. Solidity is roughly the
|
||||
fraction of the area filled by the pattern. Solidity of 0 shows
|
||||
only the background color without pattern and solidty of 1
|
||||
shows only the foreground color without pattern.
|
||||
|
||||
The 'solidity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["solidity"]
|
||||
|
||||
@solidity.setter
|
||||
def solidity(self, val):
|
||||
self["solidity"] = val
|
||||
|
||||
@property
|
||||
def soliditysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `solidity`.
|
||||
|
||||
The 'soliditysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["soliditysrc"]
|
||||
|
||||
@soliditysrc.setter
|
||||
def soliditysrc(self, val):
|
||||
self["soliditysrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
bgcolor
|
||||
When there is no colorscale sets the color of
|
||||
background pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "overlay". Otherwise,
|
||||
defaults to a transparent background.
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
fgcolor
|
||||
When there is no colorscale sets the color of
|
||||
foreground pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "replace". Otherwise,
|
||||
defaults to dark grey or white to increase contrast
|
||||
with the `bgcolor`.
|
||||
fgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`fgcolor`.
|
||||
fgopacity
|
||||
Sets the opacity of the foreground pattern fill.
|
||||
Defaults to a 0.5 when `fillmode` is "overlay".
|
||||
Otherwise, defaults to 1.
|
||||
fillmode
|
||||
Determines whether `marker.color` should be used as a
|
||||
default to `bgcolor` or a `fgcolor`.
|
||||
path
|
||||
Sets a custom path for pattern fill. Use with no
|
||||
`shape` or `solidity`, provide an SVG path string for
|
||||
the regions of the square from (0,0) to (`size`,`size`)
|
||||
to color.
|
||||
pathsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`path`.
|
||||
shape
|
||||
Sets the shape of the pattern fill. By default, no
|
||||
pattern is used for filling the area.
|
||||
shapesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shape`.
|
||||
size
|
||||
Sets the size of unit squares of the pattern fill in
|
||||
pixels, which corresponds to the interval of repetition
|
||||
of the pattern.
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
solidity
|
||||
Sets the solidity of the pattern fill. Solidity is
|
||||
roughly the fraction of the area filled by the pattern.
|
||||
Solidity of 0 shows only the background color without
|
||||
pattern and solidty of 1 shows only the foreground
|
||||
color without pattern.
|
||||
soliditysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`solidity`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
fgcolor=None,
|
||||
fgcolorsrc=None,
|
||||
fgopacity=None,
|
||||
fillmode=None,
|
||||
path=None,
|
||||
pathsrc=None,
|
||||
shape=None,
|
||||
shapesrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
solidity=None,
|
||||
soliditysrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Pattern object
|
||||
|
||||
Sets the pattern within the marker.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.marker.Pattern`
|
||||
bgcolor
|
||||
When there is no colorscale sets the color of
|
||||
background pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "overlay". Otherwise,
|
||||
defaults to a transparent background.
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
fgcolor
|
||||
When there is no colorscale sets the color of
|
||||
foreground pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "replace". Otherwise,
|
||||
defaults to dark grey or white to increase contrast
|
||||
with the `bgcolor`.
|
||||
fgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`fgcolor`.
|
||||
fgopacity
|
||||
Sets the opacity of the foreground pattern fill.
|
||||
Defaults to a 0.5 when `fillmode` is "overlay".
|
||||
Otherwise, defaults to 1.
|
||||
fillmode
|
||||
Determines whether `marker.color` should be used as a
|
||||
default to `bgcolor` or a `fgcolor`.
|
||||
path
|
||||
Sets a custom path for pattern fill. Use with no
|
||||
`shape` or `solidity`, provide an SVG path string for
|
||||
the regions of the square from (0,0) to (`size`,`size`)
|
||||
to color.
|
||||
pathsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`path`.
|
||||
shape
|
||||
Sets the shape of the pattern fill. By default, no
|
||||
pattern is used for filling the area.
|
||||
shapesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shape`.
|
||||
size
|
||||
Sets the size of unit squares of the pattern fill in
|
||||
pixels, which corresponds to the interval of repetition
|
||||
of the pattern.
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
solidity
|
||||
Sets the solidity of the pattern fill. Solidity is
|
||||
roughly the fraction of the area filled by the pattern.
|
||||
Solidity of 0 shows only the background color without
|
||||
pattern and solidty of 1 shows only the foreground
|
||||
color without pattern.
|
||||
soliditysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`solidity`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Pattern
|
||||
"""
|
||||
super().__init__("pattern")
|
||||
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.histogram.marker.Pattern
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.marker.Pattern`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("bgcolor", arg, bgcolor)
|
||||
self._set_property("bgcolorsrc", arg, bgcolorsrc)
|
||||
self._set_property("fgcolor", arg, fgcolor)
|
||||
self._set_property("fgcolorsrc", arg, fgcolorsrc)
|
||||
self._set_property("fgopacity", arg, fgopacity)
|
||||
self._set_property("fillmode", arg, fillmode)
|
||||
self._set_property("path", arg, path)
|
||||
self._set_property("pathsrc", arg, pathsrc)
|
||||
self._set_property("shape", arg, shape)
|
||||
self._set_property("shapesrc", arg, shapesrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("solidity", arg, solidity)
|
||||
self._set_property("soliditysrc", arg, soliditysrc)
|
||||
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"],
|
||||
)
|
@ -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 = "histogram.marker.colorbar"
|
||||
_path_str = "histogram.marker.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.histogram.mark
|
||||
er.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.histogram.marker.colorbar.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.marker.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 = "histogram.marker.colorbar"
|
||||
_path_str = "histogram.marker.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.histogram.mark
|
||||
er.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.histogram.marker.colorbar.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.marker.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 = "histogram.marker.colorbar"
|
||||
_path_str = "histogram.marker.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.histogram.marker.colorbar.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.histogram.marker.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.histogram.mark
|
||||
er.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.histogram.marker.colorbar.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.marker.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"])
|
@ -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 = "histogram.marker.colorbar.title"
|
||||
_path_str = "histogram.marker.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.histogram.mark
|
||||
er.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.histogram.marker.colorbar.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.marker.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,12 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._marker import Marker
|
||||
from ._textfont import Textfont
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [], ["._marker.Marker", "._textfont.Textfont"]
|
||||
)
|
@ -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 Marker(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "histogram.selected"
|
||||
_path_str = "histogram.selected.marker"
|
||||
_valid_props = {"color", "opacity"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color of selected points.
|
||||
|
||||
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 opacity(self):
|
||||
"""
|
||||
Sets the marker opacity of selected points.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the marker color of selected points.
|
||||
opacity
|
||||
Sets the marker opacity of selected points.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.selected.Marker`
|
||||
color
|
||||
Sets the marker color of selected points.
|
||||
opacity
|
||||
Sets the marker opacity of selected points.
|
||||
|
||||
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.histogram.selected.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.selected.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,81 @@
|
||||
# --- 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 = "histogram.selected"
|
||||
_path_str = "histogram.selected.textfont"
|
||||
_valid_props = {"color"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the text font color of selected points.
|
||||
|
||||
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 _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the text font color of selected points.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, **kwargs):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.selected.Textfont`
|
||||
color
|
||||
Sets the text font color of selected points.
|
||||
|
||||
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.histogram.selected.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.selected.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,12 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._marker import Marker
|
||||
from ._textfont import Textfont
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [], ["._marker.Marker", "._textfont.Textfont"]
|
||||
)
|
@ -0,0 +1,110 @@
|
||||
# --- 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 = "histogram.unselected"
|
||||
_path_str = "histogram.unselected.marker"
|
||||
_valid_props = {"color", "opacity"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color of unselected points, applied only when a
|
||||
selection exists.
|
||||
|
||||
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 opacity(self):
|
||||
"""
|
||||
Sets the marker opacity of unselected points, applied only when
|
||||
a selection exists.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the marker color of unselected points, applied
|
||||
only when a selection exists.
|
||||
opacity
|
||||
Sets the marker opacity of unselected points, applied
|
||||
only when a selection exists.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.histogram.unselected.Marker`
|
||||
color
|
||||
Sets the marker color of unselected points, applied
|
||||
only when a selection exists.
|
||||
opacity
|
||||
Sets the marker opacity of unselected points, applied
|
||||
only when a selection exists.
|
||||
|
||||
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.histogram.unselected.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.unselected.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,84 @@
|
||||
# --- 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 = "histogram.unselected"
|
||||
_path_str = "histogram.unselected.textfont"
|
||||
_valid_props = {"color"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the text font color of unselected points, applied only
|
||||
when a selection exists.
|
||||
|
||||
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 _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the text font color of unselected points, applied
|
||||
only when a selection exists.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, **kwargs):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.histogram.unse
|
||||
lected.Textfont`
|
||||
color
|
||||
Sets the text font color of unselected points, applied
|
||||
only when a selection exists.
|
||||
|
||||
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.histogram.unselected.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.histogram.unselected.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
Reference in New Issue
Block a user