some new features
This commit is contained in:
ilgazca
@ -0,0 +1,29 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._dimension import Dimension
|
||||
from ._domain import Domain
|
||||
from ._labelfont import Labelfont
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._line import Line
|
||||
from ._stream import Stream
|
||||
from ._tickfont import Tickfont
|
||||
from . import legendgrouptitle
|
||||
from . import line
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".legendgrouptitle", ".line"],
|
||||
[
|
||||
"._dimension.Dimension",
|
||||
"._domain.Domain",
|
||||
"._labelfont.Labelfont",
|
||||
"._legendgrouptitle.Legendgrouptitle",
|
||||
"._line.Line",
|
||||
"._stream.Stream",
|
||||
"._tickfont.Tickfont",
|
||||
],
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,383 @@
|
||||
# --- 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 Dimension(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats"
|
||||
_path_str = "parcats.dimension"
|
||||
_valid_props = {
|
||||
"categoryarray",
|
||||
"categoryarraysrc",
|
||||
"categoryorder",
|
||||
"displayindex",
|
||||
"label",
|
||||
"ticktext",
|
||||
"ticktextsrc",
|
||||
"values",
|
||||
"valuessrc",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def categoryarray(self):
|
||||
"""
|
||||
Sets the order in which categories in this dimension appear.
|
||||
Only has an effect if `categoryorder` is set to "array". Used
|
||||
with `categoryorder`.
|
||||
|
||||
The 'categoryarray' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["categoryarray"]
|
||||
|
||||
@categoryarray.setter
|
||||
def categoryarray(self, val):
|
||||
self["categoryarray"] = val
|
||||
|
||||
@property
|
||||
def categoryarraysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`categoryarray`.
|
||||
|
||||
The 'categoryarraysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["categoryarraysrc"]
|
||||
|
||||
@categoryarraysrc.setter
|
||||
def categoryarraysrc(self, val):
|
||||
self["categoryarraysrc"] = val
|
||||
|
||||
@property
|
||||
def categoryorder(self):
|
||||
"""
|
||||
Specifies the ordering logic for the categories in the
|
||||
dimension. By default, plotly uses "trace", which specifies the
|
||||
order that is present in the data supplied. Set `categoryorder`
|
||||
to *category ascending* or *category descending* if order
|
||||
should be determined by the alphanumerical order of the
|
||||
category names. Set `categoryorder` to "array" to derive the
|
||||
ordering from the attribute `categoryarray`. If a category is
|
||||
not found in the `categoryarray` array, the sorting behavior
|
||||
for that attribute will be identical to the "trace" mode. The
|
||||
unspecified categories will follow the categories in
|
||||
`categoryarray`.
|
||||
|
||||
The 'categoryorder' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['trace', 'category ascending', 'category descending',
|
||||
'array']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["categoryorder"]
|
||||
|
||||
@categoryorder.setter
|
||||
def categoryorder(self, val):
|
||||
self["categoryorder"] = val
|
||||
|
||||
@property
|
||||
def displayindex(self):
|
||||
"""
|
||||
The display index of dimension, from left to right, zero
|
||||
indexed, defaults to dimension index.
|
||||
|
||||
The 'displayindex' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["displayindex"]
|
||||
|
||||
@displayindex.setter
|
||||
def displayindex(self, val):
|
||||
self["displayindex"] = val
|
||||
|
||||
@property
|
||||
def label(self):
|
||||
"""
|
||||
The shown name of the dimension.
|
||||
|
||||
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
|
||||
|
||||
@property
|
||||
def ticktext(self):
|
||||
"""
|
||||
Sets alternative tick labels for the categories in this
|
||||
dimension. Only has an effect if `categoryorder` is set to
|
||||
"array". Should be an array the same length as `categoryarray`
|
||||
Used with `categoryorder`.
|
||||
|
||||
The 'ticktext' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["ticktext"]
|
||||
|
||||
@ticktext.setter
|
||||
def ticktext(self, val):
|
||||
self["ticktext"] = val
|
||||
|
||||
@property
|
||||
def ticktextsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `ticktext`.
|
||||
|
||||
The 'ticktextsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["ticktextsrc"]
|
||||
|
||||
@ticktextsrc.setter
|
||||
def ticktextsrc(self, val):
|
||||
self["ticktextsrc"] = val
|
||||
|
||||
@property
|
||||
def values(self):
|
||||
"""
|
||||
Dimension values. `values[n]` represents the category value of
|
||||
the `n`th point in the dataset, therefore the `values` vector
|
||||
for all dimensions must be the same (longer vectors will be
|
||||
truncated).
|
||||
|
||||
The 'values' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["values"]
|
||||
|
||||
@values.setter
|
||||
def values(self, val):
|
||||
self["values"] = val
|
||||
|
||||
@property
|
||||
def valuessrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `values`.
|
||||
|
||||
The 'valuessrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["valuessrc"]
|
||||
|
||||
@valuessrc.setter
|
||||
def valuessrc(self, val):
|
||||
self["valuessrc"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Shows the dimension when set to `true` (the default). Hides the
|
||||
dimension for `false`.
|
||||
|
||||
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 _prop_descriptions(self):
|
||||
return """\
|
||||
categoryarray
|
||||
Sets the order in which categories in this dimension
|
||||
appear. Only has an effect if `categoryorder` is set to
|
||||
"array". Used with `categoryorder`.
|
||||
categoryarraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`categoryarray`.
|
||||
categoryorder
|
||||
Specifies the ordering logic for the categories in the
|
||||
dimension. By default, plotly uses "trace", which
|
||||
specifies the order that is present in the data
|
||||
supplied. Set `categoryorder` to *category ascending*
|
||||
or *category descending* if order should be determined
|
||||
by the alphanumerical order of the category names. Set
|
||||
`categoryorder` to "array" to derive the ordering from
|
||||
the attribute `categoryarray`. If a category is not
|
||||
found in the `categoryarray` array, the sorting
|
||||
behavior for that attribute will be identical to the
|
||||
"trace" mode. The unspecified categories will follow
|
||||
the categories in `categoryarray`.
|
||||
displayindex
|
||||
The display index of dimension, from left to right,
|
||||
zero indexed, defaults to dimension index.
|
||||
label
|
||||
The shown name of the dimension.
|
||||
ticktext
|
||||
Sets alternative tick labels for the categories in this
|
||||
dimension. Only has an effect if `categoryorder` is set
|
||||
to "array". Should be an array the same length as
|
||||
`categoryarray` Used with `categoryorder`.
|
||||
ticktextsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ticktext`.
|
||||
values
|
||||
Dimension values. `values[n]` represents the category
|
||||
value of the `n`th point in the dataset, therefore the
|
||||
`values` vector for all dimensions must be the same
|
||||
(longer vectors will be truncated).
|
||||
valuessrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`values`.
|
||||
visible
|
||||
Shows the dimension when set to `true` (the default).
|
||||
Hides the dimension for `false`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
categoryarray=None,
|
||||
categoryarraysrc=None,
|
||||
categoryorder=None,
|
||||
displayindex=None,
|
||||
label=None,
|
||||
ticktext=None,
|
||||
ticktextsrc=None,
|
||||
values=None,
|
||||
valuessrc=None,
|
||||
visible=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Dimension object
|
||||
|
||||
The dimensions (variables) of the parallel categories diagram.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.parcats.Dimension`
|
||||
categoryarray
|
||||
Sets the order in which categories in this dimension
|
||||
appear. Only has an effect if `categoryorder` is set to
|
||||
"array". Used with `categoryorder`.
|
||||
categoryarraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`categoryarray`.
|
||||
categoryorder
|
||||
Specifies the ordering logic for the categories in the
|
||||
dimension. By default, plotly uses "trace", which
|
||||
specifies the order that is present in the data
|
||||
supplied. Set `categoryorder` to *category ascending*
|
||||
or *category descending* if order should be determined
|
||||
by the alphanumerical order of the category names. Set
|
||||
`categoryorder` to "array" to derive the ordering from
|
||||
the attribute `categoryarray`. If a category is not
|
||||
found in the `categoryarray` array, the sorting
|
||||
behavior for that attribute will be identical to the
|
||||
"trace" mode. The unspecified categories will follow
|
||||
the categories in `categoryarray`.
|
||||
displayindex
|
||||
The display index of dimension, from left to right,
|
||||
zero indexed, defaults to dimension index.
|
||||
label
|
||||
The shown name of the dimension.
|
||||
ticktext
|
||||
Sets alternative tick labels for the categories in this
|
||||
dimension. Only has an effect if `categoryorder` is set
|
||||
to "array". Should be an array the same length as
|
||||
`categoryarray` Used with `categoryorder`.
|
||||
ticktextsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ticktext`.
|
||||
values
|
||||
Dimension values. `values[n]` represents the category
|
||||
value of the `n`th point in the dataset, therefore the
|
||||
`values` vector for all dimensions must be the same
|
||||
(longer vectors will be truncated).
|
||||
valuessrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`values`.
|
||||
visible
|
||||
Shows the dimension when set to `true` (the default).
|
||||
Hides the dimension for `false`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Dimension
|
||||
"""
|
||||
super().__init__("dimensions")
|
||||
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.parcats.Dimension
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.Dimension`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("categoryarray", arg, categoryarray)
|
||||
self._set_property("categoryarraysrc", arg, categoryarraysrc)
|
||||
self._set_property("categoryorder", arg, categoryorder)
|
||||
self._set_property("displayindex", arg, displayindex)
|
||||
self._set_property("label", arg, label)
|
||||
self._set_property("ticktext", arg, ticktext)
|
||||
self._set_property("ticktextsrc", arg, ticktextsrc)
|
||||
self._set_property("values", arg, values)
|
||||
self._set_property("valuessrc", arg, valuessrc)
|
||||
self._set_property("visible", arg, visible)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,170 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Domain(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats"
|
||||
_path_str = "parcats.domain"
|
||||
_valid_props = {"column", "row", "x", "y"}
|
||||
|
||||
@property
|
||||
def column(self):
|
||||
"""
|
||||
If there is a layout grid, use the domain for this column in
|
||||
the grid for this parcats trace .
|
||||
|
||||
The 'column' 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["column"]
|
||||
|
||||
@column.setter
|
||||
def column(self, val):
|
||||
self["column"] = val
|
||||
|
||||
@property
|
||||
def row(self):
|
||||
"""
|
||||
If there is a layout grid, use the domain for this row in the
|
||||
grid for this parcats trace .
|
||||
|
||||
The 'row' 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["row"]
|
||||
|
||||
@row.setter
|
||||
def row(self, val):
|
||||
self["row"] = val
|
||||
|
||||
@property
|
||||
def x(self):
|
||||
"""
|
||||
Sets the horizontal domain of this parcats trace (in plot
|
||||
fraction).
|
||||
|
||||
The 'x' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'x[0]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
(1) The 'x[1]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["x"]
|
||||
|
||||
@x.setter
|
||||
def x(self, val):
|
||||
self["x"] = val
|
||||
|
||||
@property
|
||||
def y(self):
|
||||
"""
|
||||
Sets the vertical domain of this parcats trace (in plot
|
||||
fraction).
|
||||
|
||||
The 'y' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'y[0]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
(1) The 'y[1]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["y"]
|
||||
|
||||
@y.setter
|
||||
def y(self, val):
|
||||
self["y"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
column
|
||||
If there is a layout grid, use the domain for this
|
||||
column in the grid for this parcats trace .
|
||||
row
|
||||
If there is a layout grid, use the domain for this row
|
||||
in the grid for this parcats trace .
|
||||
x
|
||||
Sets the horizontal domain of this parcats trace (in
|
||||
plot fraction).
|
||||
y
|
||||
Sets the vertical domain of this parcats trace (in plot
|
||||
fraction).
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
|
||||
"""
|
||||
Construct a new Domain object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.parcats.Domain`
|
||||
column
|
||||
If there is a layout grid, use the domain for this
|
||||
column in the grid for this parcats trace .
|
||||
row
|
||||
If there is a layout grid, use the domain for this row
|
||||
in the grid for this parcats trace .
|
||||
x
|
||||
Sets the horizontal domain of this parcats trace (in
|
||||
plot fraction).
|
||||
y
|
||||
Sets the vertical domain of this parcats trace (in plot
|
||||
fraction).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Domain
|
||||
"""
|
||||
super().__init__("domain")
|
||||
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.parcats.Domain
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.Domain`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("column", arg, column)
|
||||
self._set_property("row", arg, row)
|
||||
self._set_property("x", arg, x)
|
||||
self._set_property("y", arg, y)
|
||||
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 Labelfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats"
|
||||
_path_str = "parcats.labelfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Labelfont object
|
||||
|
||||
Sets the font for the `dimension` labels.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.parcats.Labelfont`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Labelfont
|
||||
"""
|
||||
super().__init__("labelfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.parcats.Labelfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.Labelfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,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 = "parcats"
|
||||
_path_str = "parcats.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.parcats.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.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.parcats.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.parcats.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.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,680 @@
|
||||
# --- 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 = "parcats"
|
||||
_path_str = "parcats.line"
|
||||
_valid_props = {
|
||||
"autocolorscale",
|
||||
"cauto",
|
||||
"cmax",
|
||||
"cmid",
|
||||
"cmin",
|
||||
"color",
|
||||
"coloraxis",
|
||||
"colorbar",
|
||||
"colorscale",
|
||||
"colorsrc",
|
||||
"hovertemplate",
|
||||
"reversescale",
|
||||
"shape",
|
||||
"showscale",
|
||||
}
|
||||
|
||||
@property
|
||||
def autocolorscale(self):
|
||||
"""
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`line.colorscale`. Has an effect only if in `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 `line.color`) or the bounds
|
||||
set in `line.cmin` and `line.cmax` Has an effect only if in
|
||||
`line.color` is set to a numerical array. Defaults to `false`
|
||||
when `line.cmin` and `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 `line.color` is set to a numerical array. Value should have
|
||||
the same units as in `line.color` and if set, `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 `line.cmin`
|
||||
and/or `line.cmax` to be equidistant to this point. Has an
|
||||
effect only if in `line.color` is set to a numerical array.
|
||||
Value should have the same units as in `line.color`. Has no
|
||||
effect when `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 `line.color` is set to a numerical array. Value should have
|
||||
the same units as in `line.color` and if set, `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 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 `line.cmin`
|
||||
and `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 parcats.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 colorbar(self):
|
||||
"""
|
||||
The 'colorbar' property is an instance of ColorBar
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.line.ColorBar`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the ColorBar constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.line.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 `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
|
||||
`line.cmin` and `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,Portla
|
||||
nd,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 hovertemplate(self):
|
||||
"""
|
||||
Template string used for rendering the information that appear
|
||||
on hover box. Note that this will override `hoverinfo`.
|
||||
Variables are inserted using %{variable}, for example "y: %{y}"
|
||||
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
|
||||
showing info for several points, "xother" will be added to
|
||||
those with different x positions from the first point. An
|
||||
underscore before or after "(x|y)other" will add a space on
|
||||
that side, only when this field is shown. Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for example
|
||||
"Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
|
||||
details on the formatting syntax. Dates are formatted using
|
||||
d3-time-format's syntax %{variable|d3-time-format}, for example
|
||||
"Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the date
|
||||
formatting syntax. The variables available in `hovertemplate`
|
||||
are the ones emitted as event data described at this link
|
||||
https://plotly.com/javascript/plotlyjs-events/#event-data.
|
||||
Additionally, every attributes that can be specified per-point
|
||||
(the ones that are `arrayOk: true`) are available. This value
|
||||
here applies when hovering over lines.Finally, the template
|
||||
string has access to variables `count` and `probability`.
|
||||
Anything contained in tag `<extra>` is displayed in the
|
||||
secondary box, for example "<extra>{fullData.name}</extra>". To
|
||||
hide the secondary box completely, use an empty tag
|
||||
`<extra></extra>`.
|
||||
|
||||
The 'hovertemplate' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["hovertemplate"]
|
||||
|
||||
@hovertemplate.setter
|
||||
def hovertemplate(self, val):
|
||||
self["hovertemplate"] = val
|
||||
|
||||
@property
|
||||
def reversescale(self):
|
||||
"""
|
||||
Reverses the color mapping if true. Has an effect only if in
|
||||
`line.color` is set to a numerical array. If true, `line.cmin`
|
||||
will correspond to the last color in the array and `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 shape(self):
|
||||
"""
|
||||
Sets the shape of the paths. If `linear`, paths are composed of
|
||||
straight lines. If `hspline`, paths are composed of horizontal
|
||||
curved splines
|
||||
|
||||
The 'shape' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['linear', 'hspline']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["shape"]
|
||||
|
||||
@shape.setter
|
||||
def shape(self, val):
|
||||
self["shape"] = val
|
||||
|
||||
@property
|
||||
def showscale(self):
|
||||
"""
|
||||
Determines whether or not a colorbar is displayed for this
|
||||
trace. Has an effect only if in `line.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
|
||||
`line.colorscale`. Has an effect only if in
|
||||
`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 `line.color`)
|
||||
or the bounds set in `line.cmin` and `line.cmax` Has an
|
||||
effect only if in `line.color` is set to a numerical
|
||||
array. Defaults to `false` when `line.cmin` and
|
||||
`line.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `line.color` is set to a numerical array.
|
||||
Value should have the same units as in `line.color` and
|
||||
if set, `line.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`line.cmin` and/or `line.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `line.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `line.color`. Has no effect when
|
||||
`line.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `line.color` is set to a numerical array.
|
||||
Value should have the same units as in `line.color` and
|
||||
if set, `line.cmax` must be set as well.
|
||||
color
|
||||
Sets the 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 `line.cmin` and `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.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.parcats.line.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`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 `line.cmin` and `line.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`.
|
||||
hovertemplate
|
||||
Template string used for rendering the information that
|
||||
appear on hover box. Note that this will override
|
||||
`hoverinfo`. Variables are inserted using %{variable},
|
||||
for example "y: %{y}" as well as %{xother}, {%_xother},
|
||||
{%_xother_}, {%xother_}. When showing info for several
|
||||
points, "xother" will be added to those with different
|
||||
x positions from the first point. An underscore before
|
||||
or after "(x|y)other" will add a space on that side,
|
||||
only when this field is shown. Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for
|
||||
example "Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day:
|
||||
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax. The variables available in
|
||||
`hovertemplate` are the ones emitted as event data
|
||||
described at this link
|
||||
https://plotly.com/javascript/plotlyjs-events/#event-
|
||||
data. Additionally, every attributes that can be
|
||||
specified per-point (the ones that are `arrayOk: true`)
|
||||
are available. This value here applies when hovering
|
||||
over lines.Finally, the template string has access to
|
||||
variables `count` and `probability`. Anything contained
|
||||
in tag `<extra>` is displayed in the secondary box, for
|
||||
example "<extra>{fullData.name}</extra>". To hide the
|
||||
secondary box completely, use an empty tag
|
||||
`<extra></extra>`.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `line.color` is set to a numerical array. If
|
||||
true, `line.cmin` will correspond to the last color in
|
||||
the array and `line.cmax` will correspond to the first
|
||||
color.
|
||||
shape
|
||||
Sets the shape of the paths. If `linear`, paths are
|
||||
composed of straight lines. If `hspline`, paths are
|
||||
composed of horizontal curved splines
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `line.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,
|
||||
hovertemplate=None,
|
||||
reversescale=None,
|
||||
shape=None,
|
||||
showscale=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Line object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.parcats.Line`
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`line.colorscale`. Has an effect only if in
|
||||
`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 `line.color`)
|
||||
or the bounds set in `line.cmin` and `line.cmax` Has an
|
||||
effect only if in `line.color` is set to a numerical
|
||||
array. Defaults to `false` when `line.cmin` and
|
||||
`line.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `line.color` is set to a numerical array.
|
||||
Value should have the same units as in `line.color` and
|
||||
if set, `line.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`line.cmin` and/or `line.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `line.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `line.color`. Has no effect when
|
||||
`line.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `line.color` is set to a numerical array.
|
||||
Value should have the same units as in `line.color` and
|
||||
if set, `line.cmax` must be set as well.
|
||||
color
|
||||
Sets the 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 `line.cmin` and `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.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.parcats.line.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`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 `line.cmin` and `line.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`.
|
||||
hovertemplate
|
||||
Template string used for rendering the information that
|
||||
appear on hover box. Note that this will override
|
||||
`hoverinfo`. Variables are inserted using %{variable},
|
||||
for example "y: %{y}" as well as %{xother}, {%_xother},
|
||||
{%_xother_}, {%xother_}. When showing info for several
|
||||
points, "xother" will be added to those with different
|
||||
x positions from the first point. An underscore before
|
||||
or after "(x|y)other" will add a space on that side,
|
||||
only when this field is shown. Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for
|
||||
example "Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day:
|
||||
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax. The variables available in
|
||||
`hovertemplate` are the ones emitted as event data
|
||||
described at this link
|
||||
https://plotly.com/javascript/plotlyjs-events/#event-
|
||||
data. Additionally, every attributes that can be
|
||||
specified per-point (the ones that are `arrayOk: true`)
|
||||
are available. This value here applies when hovering
|
||||
over lines.Finally, the template string has access to
|
||||
variables `count` and `probability`. Anything contained
|
||||
in tag `<extra>` is displayed in the secondary box, for
|
||||
example "<extra>{fullData.name}</extra>". To hide the
|
||||
secondary box completely, use an empty tag
|
||||
`<extra></extra>`.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `line.color` is set to a numerical array. If
|
||||
true, `line.cmin` will correspond to the last color in
|
||||
the array and `line.cmax` will correspond to the first
|
||||
color.
|
||||
shape
|
||||
Sets the shape of the paths. If `linear`, paths are
|
||||
composed of straight lines. If `hspline`, paths are
|
||||
composed of horizontal curved splines
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `line.color` is
|
||||
set to a numerical array.
|
||||
|
||||
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.parcats.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.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("colorbar", arg, colorbar)
|
||||
self._set_property("colorscale", arg, colorscale)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("hovertemplate", arg, hovertemplate)
|
||||
self._set_property("reversescale", arg, reversescale)
|
||||
self._set_property("shape", arg, shape)
|
||||
self._set_property("showscale", arg, showscale)
|
||||
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 = "parcats"
|
||||
_path_str = "parcats.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.parcats.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.parcats.Stream
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.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 Tickfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats"
|
||||
_path_str = "parcats.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 font for the `category` labels.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.parcats.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.parcats.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.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,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats.legendgrouptitle"
|
||||
_path_str = "parcats.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.parcats.legend
|
||||
grouptitle.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.parcats.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.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,12 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._colorbar import ColorBar
|
||||
from . import colorbar
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [".colorbar"], ["._colorbar.ColorBar"]
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"],
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats.line.colorbar"
|
||||
_path_str = "parcats.line.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.parcats.line.c
|
||||
olorbar.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.parcats.line.colorbar.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.line.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 = "parcats.line.colorbar"
|
||||
_path_str = "parcats.line.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.parcats.line.c
|
||||
olorbar.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.parcats.line.colorbar.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.line.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 = "parcats.line.colorbar"
|
||||
_path_str = "parcats.line.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.parcats.line.colorbar.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.line.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.parcats.line.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.parcats.line.colorbar.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Title`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("side", arg, side)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "parcats.line.colorbar.title"
|
||||
_path_str = "parcats.line.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.parcats.line.c
|
||||
olorbar.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.parcats.line.colorbar.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.parcats.line.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
|
||||
Reference in New Issue
Block a user