mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-07-02 06:22:25 +00:00
first commit
This commit is contained in:
Ayxan
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or TYPE_CHECKING:
|
||||
from ._colorscale import Colorscale
|
||||
from ._hoverlabel import Hoverlabel
|
||||
from ._line import Line
|
||||
from . import hoverlabel
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".hoverlabel"],
|
||||
["._colorscale.Colorscale", "._hoverlabel.Hoverlabel", "._line.Line"],
|
||||
)
|
||||
@ -0,0 +1,351 @@
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Colorscale(_BaseTraceHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "sankey.link"
|
||||
_path_str = "sankey.link.colorscale"
|
||||
_valid_props = {"cmax", "cmin", "colorscale", "label", "name", "templateitemname"}
|
||||
|
||||
# cmax
|
||||
# ----
|
||||
@property
|
||||
def cmax(self):
|
||||
"""
|
||||
Sets the upper bound of the color domain.
|
||||
|
||||
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
|
||||
|
||||
# cmin
|
||||
# ----
|
||||
@property
|
||||
def cmin(self):
|
||||
"""
|
||||
Sets the lower bound of the color domain.
|
||||
|
||||
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
|
||||
|
||||
# colorscale
|
||||
# ----------
|
||||
@property
|
||||
def colorscale(self):
|
||||
"""
|
||||
Sets the colorscale. 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 `cmin` and `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
|
||||
|
||||
# label
|
||||
# -----
|
||||
@property
|
||||
def label(self):
|
||||
"""
|
||||
The label of the links to color based on their concentration
|
||||
within a flow.
|
||||
|
||||
The 'label' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["label"]
|
||||
|
||||
@label.setter
|
||||
def label(self, val):
|
||||
self["label"] = val
|
||||
|
||||
# name
|
||||
# ----
|
||||
@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
|
||||
|
||||
# templateitemname
|
||||
# ----------------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
cmax
|
||||
Sets the upper bound of the color domain.
|
||||
cmin
|
||||
Sets the lower bound of the color domain.
|
||||
colorscale
|
||||
Sets the colorscale. 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 `cmin` and `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.
|
||||
label
|
||||
The label of the links to color based on their
|
||||
concentration within a flow.
|
||||
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`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
cmax=None,
|
||||
cmin=None,
|
||||
colorscale=None,
|
||||
label=None,
|
||||
name=None,
|
||||
templateitemname=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Colorscale object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.sankey.link.Colorscale`
|
||||
cmax
|
||||
Sets the upper bound of the color domain.
|
||||
cmin
|
||||
Sets the lower bound of the color domain.
|
||||
colorscale
|
||||
Sets the colorscale. 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 `cmin` and `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.
|
||||
label
|
||||
The label of the links to color based on their
|
||||
concentration within a flow.
|
||||
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`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Colorscale
|
||||
"""
|
||||
super(Colorscale, self).__init__("colorscales")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.link.Colorscale
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.sankey.link.Colorscale`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("cmax", None)
|
||||
_v = cmax if cmax is not None else _v
|
||||
if _v is not None:
|
||||
self["cmax"] = _v
|
||||
_v = arg.pop("cmin", None)
|
||||
_v = cmin if cmin is not None else _v
|
||||
if _v is not None:
|
||||
self["cmin"] = _v
|
||||
_v = arg.pop("colorscale", None)
|
||||
_v = colorscale if colorscale is not None else _v
|
||||
if _v is not None:
|
||||
self["colorscale"] = _v
|
||||
_v = arg.pop("label", None)
|
||||
_v = label if label is not None else _v
|
||||
if _v is not None:
|
||||
self["label"] = _v
|
||||
_v = arg.pop("name", None)
|
||||
_v = name if name is not None else _v
|
||||
if _v is not None:
|
||||
self["name"] = _v
|
||||
_v = arg.pop("templateitemname", None)
|
||||
_v = templateitemname if templateitemname is not None else _v
|
||||
if _v is not None:
|
||||
self["templateitemname"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,503 @@
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Hoverlabel(_BaseTraceHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "sankey.link"
|
||||
_path_str = "sankey.link.hoverlabel"
|
||||
_valid_props = {
|
||||
"align",
|
||||
"alignsrc",
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"bordercolor",
|
||||
"bordercolorsrc",
|
||||
"font",
|
||||
"namelength",
|
||||
"namelengthsrc",
|
||||
}
|
||||
|
||||
# align
|
||||
# -----
|
||||
@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
|
||||
|
||||
# alignsrc
|
||||
# --------
|
||||
@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
|
||||
|
||||
# bgcolor
|
||||
# -------
|
||||
@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:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
- 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
|
||||
|
||||
# bgcolorsrc
|
||||
# ----------
|
||||
@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
|
||||
|
||||
# bordercolor
|
||||
# -----------
|
||||
@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:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
- 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
|
||||
|
||||
# bordercolorsrc
|
||||
# --------------
|
||||
@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
|
||||
|
||||
# font
|
||||
# ----
|
||||
@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.sankey.link.hoverlabel.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Supported dict properties:
|
||||
|
||||
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
|
||||
will only be able to apply a font if it is
|
||||
available on the system which it operates.
|
||||
Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to
|
||||
apply fonts if they aren't available on the
|
||||
system. The Chart Studio Cloud (at
|
||||
https://chart-studio.plotly.com or on-premise)
|
||||
generates images on a server, where only a
|
||||
select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto",
|
||||
"Courier New", "Droid Sans",, "Droid Serif",
|
||||
"Droid Sans Mono", "Gravitas One", "Old
|
||||
Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud
|
||||
for `family`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud
|
||||
for `size`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.link.hoverlabel.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
# namelength
|
||||
# ----------
|
||||
@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
|
||||
|
||||
# namelengthsrc
|
||||
# -------------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
align=None,
|
||||
alignsrc=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
bordercolor=None,
|
||||
bordercolorsrc=None,
|
||||
font=None,
|
||||
namelength=None,
|
||||
namelengthsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Hoverlabel object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.sankey.link.Hoverlabel`
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Hoverlabel
|
||||
"""
|
||||
super(Hoverlabel, self).__init__("hoverlabel")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.link.Hoverlabel
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.sankey.link.Hoverlabel`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("align", None)
|
||||
_v = align if align is not None else _v
|
||||
if _v is not None:
|
||||
self["align"] = _v
|
||||
_v = arg.pop("alignsrc", None)
|
||||
_v = alignsrc if alignsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["alignsrc"] = _v
|
||||
_v = arg.pop("bgcolor", None)
|
||||
_v = bgcolor if bgcolor is not None else _v
|
||||
if _v is not None:
|
||||
self["bgcolor"] = _v
|
||||
_v = arg.pop("bgcolorsrc", None)
|
||||
_v = bgcolorsrc if bgcolorsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["bgcolorsrc"] = _v
|
||||
_v = arg.pop("bordercolor", None)
|
||||
_v = bordercolor if bordercolor is not None else _v
|
||||
if _v is not None:
|
||||
self["bordercolor"] = _v
|
||||
_v = arg.pop("bordercolorsrc", None)
|
||||
_v = bordercolorsrc if bordercolorsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["bordercolorsrc"] = _v
|
||||
_v = arg.pop("font", None)
|
||||
_v = font if font is not None else _v
|
||||
if _v is not None:
|
||||
self["font"] = _v
|
||||
_v = arg.pop("namelength", None)
|
||||
_v = namelength if namelength is not None else _v
|
||||
if _v is not None:
|
||||
self["namelength"] = _v
|
||||
_v = arg.pop("namelengthsrc", None)
|
||||
_v = namelengthsrc if namelengthsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["namelengthsrc"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
232
.venv/Lib/site-packages/plotly/graph_objs/sankey/link/_line.py
Normal file
232
.venv/Lib/site-packages/plotly/graph_objs/sankey/link/_line.py
Normal file
@ -0,0 +1,232 @@
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Line(_BaseTraceHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "sankey.link"
|
||||
_path_str = "sankey.link.line"
|
||||
_valid_props = {"color", "colorsrc", "width", "widthsrc"}
|
||||
|
||||
# color
|
||||
# -----
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the color of the `line` around each `link`.
|
||||
|
||||
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:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
- 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
|
||||
|
||||
# colorsrc
|
||||
# --------
|
||||
@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
|
||||
|
||||
# width
|
||||
# -----
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the `line` around each `link`.
|
||||
|
||||
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
|
||||
|
||||
# widthsrc
|
||||
# --------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the color of the `line` around each `link`.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
width
|
||||
Sets the width (in px) of the `line` around each
|
||||
`link`.
|
||||
widthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`width`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self, arg=None, color=None, colorsrc=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.sankey.link.Line`
|
||||
color
|
||||
Sets the color of the `line` around each `link`.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
width
|
||||
Sets the width (in px) of the `line` around each
|
||||
`link`.
|
||||
widthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`width`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Line
|
||||
"""
|
||||
super(Line, self).__init__("line")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.link.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.sankey.link.Line`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("color", None)
|
||||
_v = color if color is not None else _v
|
||||
if _v is not None:
|
||||
self["color"] = _v
|
||||
_v = arg.pop("colorsrc", None)
|
||||
_v = colorsrc if colorsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["colorsrc"] = _v
|
||||
_v = arg.pop("width", None)
|
||||
_v = width if width is not None else _v
|
||||
if _v is not None:
|
||||
self["width"] = _v
|
||||
_v = arg.pop("widthsrc", None)
|
||||
_v = widthsrc if widthsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["widthsrc"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or 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,330 @@
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "sankey.link.hoverlabel"
|
||||
_path_str = "sankey.link.hoverlabel.font"
|
||||
_valid_props = {"color", "colorsrc", "family", "familysrc", "size", "sizesrc"}
|
||||
|
||||
# color
|
||||
# -----
|
||||
@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:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
- 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
|
||||
|
||||
# colorsrc
|
||||
# --------
|
||||
@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
|
||||
|
||||
# family
|
||||
# ------
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser will only be able to apply a font if
|
||||
it is available on the system which it operates. Provide
|
||||
multiple font families, separated by commas, to indicate the
|
||||
preference in which to apply fonts if they aren't available on
|
||||
the system. The Chart Studio Cloud (at https://chart-
|
||||
studio.plotly.com or on-premise) generates images on a server,
|
||||
where only a select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto", "Courier New",
|
||||
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
|
||||
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
|
||||
|
||||
# familysrc
|
||||
# ---------
|
||||
@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
|
||||
|
||||
# size
|
||||
# ----
|
||||
@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
|
||||
|
||||
# sizesrc
|
||||
# -------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@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 will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
size=None,
|
||||
sizesrc=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.link.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 will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super(Font, self).__init__("font")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.link.hoverlabel.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("color", None)
|
||||
_v = color if color is not None else _v
|
||||
if _v is not None:
|
||||
self["color"] = _v
|
||||
_v = arg.pop("colorsrc", None)
|
||||
_v = colorsrc if colorsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["colorsrc"] = _v
|
||||
_v = arg.pop("family", None)
|
||||
_v = family if family is not None else _v
|
||||
if _v is not None:
|
||||
self["family"] = _v
|
||||
_v = arg.pop("familysrc", None)
|
||||
_v = familysrc if familysrc is not None else _v
|
||||
if _v is not None:
|
||||
self["familysrc"] = _v
|
||||
_v = arg.pop("size", None)
|
||||
_v = size if size is not None else _v
|
||||
if _v is not None:
|
||||
self["size"] = _v
|
||||
_v = arg.pop("sizesrc", None)
|
||||
_v = sizesrc if sizesrc is not None else _v
|
||||
if _v is not None:
|
||||
self["sizesrc"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
Reference in New Issue
Block a user