done
This commit is contained in:
@ -0,0 +1,26 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._aaxis import Aaxis
|
||||
from ._baxis import Baxis
|
||||
from ._font import Font
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._stream import Stream
|
||||
from . import aaxis
|
||||
from . import baxis
|
||||
from . import legendgrouptitle
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".aaxis", ".baxis", ".legendgrouptitle"],
|
||||
[
|
||||
"._aaxis.Aaxis",
|
||||
"._baxis.Baxis",
|
||||
"._font.Font",
|
||||
"._legendgrouptitle.Legendgrouptitle",
|
||||
"._stream.Stream",
|
||||
],
|
||||
)
|
1850
lib/python3.11/site-packages/plotly/graph_objs/carpet/_aaxis.py
Normal file
1850
lib/python3.11/site-packages/plotly/graph_objs/carpet/_aaxis.py
Normal file
File diff suppressed because it is too large
Load Diff
1850
lib/python3.11/site-packages/plotly/graph_objs/carpet/_baxis.py
Normal file
1850
lib/python3.11/site-packages/plotly/graph_objs/carpet/_baxis.py
Normal file
File diff suppressed because it is too large
Load Diff
333
lib/python3.11/site-packages/plotly/graph_objs/carpet/_font.py
Normal file
333
lib/python3.11/site-packages/plotly/graph_objs/carpet/_font.py
Normal file
@ -0,0 +1,333 @@
|
||||
# --- 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 = "carpet"
|
||||
_path_str = "carpet.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
|
||||
|
||||
The default font used for axis & tick labels on this carpet
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.carpet.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.carpet.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.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,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 = "carpet"
|
||||
_path_str = "carpet.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.carpet.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.carpet.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.carpet.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.carpet.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.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
|
113
lib/python3.11/site-packages/plotly/graph_objs/carpet/_stream.py
Normal file
113
lib/python3.11/site-packages/plotly/graph_objs/carpet/_stream.py
Normal file
@ -0,0 +1,113 @@
|
||||
# --- 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 = "carpet"
|
||||
_path_str = "carpet.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.carpet.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.carpet.Stream
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.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,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"],
|
||||
)
|
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "carpet.aaxis"
|
||||
_path_str = "carpet.aaxis.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 tick font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.carpet.aaxis.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.carpet.aaxis.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.aaxis.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 = "carpet.aaxis"
|
||||
_path_str = "carpet.aaxis.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.carpet.aaxis.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.carpet.aaxis.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.aaxis.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,130 @@
|
||||
# --- 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 = "carpet.aaxis"
|
||||
_path_str = "carpet.aaxis.title"
|
||||
_valid_props = {"font", "offset", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this axis' title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.carpet.aaxis.title.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def offset(self):
|
||||
"""
|
||||
An additional amount by which to offset the title from the tick
|
||||
labels, given in pixels.
|
||||
|
||||
The 'offset' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["offset"]
|
||||
|
||||
@offset.setter
|
||||
def offset(self, val):
|
||||
self["offset"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of this axis.
|
||||
|
||||
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 axis' title font.
|
||||
offset
|
||||
An additional amount by which to offset the title from
|
||||
the tick labels, given in pixels.
|
||||
text
|
||||
Sets the title of this axis.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, offset=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.carpet.aaxis.Title`
|
||||
font
|
||||
Sets this axis' title font.
|
||||
offset
|
||||
An additional amount by which to offset the title from
|
||||
the tick labels, given in pixels.
|
||||
text
|
||||
Sets the title of this axis.
|
||||
|
||||
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.carpet.aaxis.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.aaxis.Title`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("offset", arg, offset)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "carpet.aaxis.title"
|
||||
_path_str = "carpet.aaxis.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 axis' title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.carpet.aaxis.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.carpet.aaxis.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"],
|
||||
)
|
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "carpet.baxis"
|
||||
_path_str = "carpet.baxis.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 tick font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.carpet.baxis.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.carpet.baxis.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.baxis.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 = "carpet.baxis"
|
||||
_path_str = "carpet.baxis.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.carpet.baxis.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.carpet.baxis.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.baxis.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,130 @@
|
||||
# --- 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 = "carpet.baxis"
|
||||
_path_str = "carpet.baxis.title"
|
||||
_valid_props = {"font", "offset", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this axis' title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.carpet.baxis.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.carpet.baxis.title.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def offset(self):
|
||||
"""
|
||||
An additional amount by which to offset the title from the tick
|
||||
labels, given in pixels.
|
||||
|
||||
The 'offset' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["offset"]
|
||||
|
||||
@offset.setter
|
||||
def offset(self, val):
|
||||
self["offset"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of this axis.
|
||||
|
||||
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 axis' title font.
|
||||
offset
|
||||
An additional amount by which to offset the title from
|
||||
the tick labels, given in pixels.
|
||||
text
|
||||
Sets the title of this axis.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, offset=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.carpet.baxis.Title`
|
||||
font
|
||||
Sets this axis' title font.
|
||||
offset
|
||||
An additional amount by which to offset the title from
|
||||
the tick labels, given in pixels.
|
||||
text
|
||||
Sets the title of this axis.
|
||||
|
||||
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.carpet.baxis.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.baxis.Title`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("offset", arg, offset)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "carpet.baxis.title"
|
||||
_path_str = "carpet.baxis.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 axis' title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.carpet.baxis.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.carpet.baxis.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.baxis.title.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "carpet.legendgrouptitle"
|
||||
_path_str = "carpet.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.carpet.legendgrouptitle.Font`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.carpet.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.carpet.legendgrouptitle.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
Reference in New Issue
Block a user