done
This commit is contained in:
@ -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 = "sankey.node.hoverlabel"
|
||||
_path_str = "sankey.node.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.sankey.node.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.sankey.node.hoverlabel.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.sankey.node.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
|
||||
Reference in New Issue
Block a user