done
This commit is contained in:
@ -0,0 +1,17 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._label import Label
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._line import Line
|
||||
from . import label
|
||||
from . import legendgrouptitle
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".label", ".legendgrouptitle"],
|
||||
["._label.Label", "._legendgrouptitle.Legendgrouptitle", "._line.Line"],
|
||||
)
|
||||
@ -0,0 +1,396 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Label(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.shape"
|
||||
_path_str = "layout.shape.label"
|
||||
_valid_props = {
|
||||
"font",
|
||||
"padding",
|
||||
"text",
|
||||
"textangle",
|
||||
"textposition",
|
||||
"texttemplate",
|
||||
"xanchor",
|
||||
"yanchor",
|
||||
}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets the shape label text font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.layout.shape.label.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.shape.label.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def padding(self):
|
||||
"""
|
||||
Sets padding (in px) between edge of label and edge of shape.
|
||||
|
||||
The 'padding' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["padding"]
|
||||
|
||||
@padding.setter
|
||||
def padding(self, val):
|
||||
self["padding"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the text to display with shape. It is also used for legend
|
||||
item if `name` is not provided.
|
||||
|
||||
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 textangle(self):
|
||||
"""
|
||||
Sets the angle at which the label text is drawn with respect to
|
||||
the horizontal. For lines, angle "auto" is the same angle as
|
||||
the line. For all other shapes, angle "auto" is horizontal.
|
||||
|
||||
The 'textangle' property is a angle (in degrees) that may be
|
||||
specified as a number between -180 and 180.
|
||||
Numeric values outside this range are converted to the equivalent value
|
||||
(e.g. 270 is converted to -90).
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["textangle"]
|
||||
|
||||
@textangle.setter
|
||||
def textangle(self, val):
|
||||
self["textangle"] = val
|
||||
|
||||
@property
|
||||
def textposition(self):
|
||||
"""
|
||||
Sets the position of the label text relative to the shape.
|
||||
Supported values for rectangles, circles and paths are *top
|
||||
left*, *top center*, *top right*, *middle left*, *middle
|
||||
center*, *middle right*, *bottom left*, *bottom center*, and
|
||||
*bottom right*. Supported values for lines are "start",
|
||||
"middle", and "end". Default: *middle center* for rectangles,
|
||||
circles, and paths; "middle" for lines.
|
||||
|
||||
The 'textposition' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['top left', 'top center', 'top right', 'middle left',
|
||||
'middle center', 'middle right', 'bottom left', 'bottom
|
||||
center', 'bottom right', 'start', 'middle', 'end']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textposition"]
|
||||
|
||||
@textposition.setter
|
||||
def textposition(self, val):
|
||||
self["textposition"] = val
|
||||
|
||||
@property
|
||||
def texttemplate(self):
|
||||
"""
|
||||
Template string used for rendering the shape's label. Note that
|
||||
this will override `text`. Variables are inserted using
|
||||
%{variable}, for example "x0: %{x0}". Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for example
|
||||
"Price: %{x0:$.2f}". See
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
|
||||
details on the formatting syntax. Dates are formatted using
|
||||
d3-time-format's syntax %{variable|d3-time-format}, for example
|
||||
"Day: %{x0|%m %b %Y}". See https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the date
|
||||
formatting syntax. A single multiplication or division
|
||||
operation may be applied to numeric variables, and combined
|
||||
with d3 number formatting, for example "Length in cm:
|
||||
%{x0*2.54}", "%{slope*60:.1f} meters per second." For log axes,
|
||||
variable values are given in log units. For date axes, x/y
|
||||
coordinate variables and center variables use datetimes, while
|
||||
all other variable values use values in ms. Finally, the
|
||||
template string has access to variables `x0`, `x1`, `y0`, `y1`,
|
||||
`slope`, `dx`, `dy`, `width`, `height`, `length`, `xcenter` and
|
||||
`ycenter`.
|
||||
|
||||
The 'texttemplate' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["texttemplate"]
|
||||
|
||||
@texttemplate.setter
|
||||
def texttemplate(self, val):
|
||||
self["texttemplate"] = val
|
||||
|
||||
@property
|
||||
def xanchor(self):
|
||||
"""
|
||||
Sets the label's horizontal position anchor This anchor binds
|
||||
the specified `textposition` to the "left", "center" or "right"
|
||||
of the label text. For example, if `textposition` is set to
|
||||
*top right* and `xanchor` to "right" then the right-most
|
||||
portion of the label text lines up with the right-most edge of
|
||||
the shape.
|
||||
|
||||
The 'xanchor' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['auto', 'left', 'center', 'right']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["xanchor"]
|
||||
|
||||
@xanchor.setter
|
||||
def xanchor(self, val):
|
||||
self["xanchor"] = val
|
||||
|
||||
@property
|
||||
def yanchor(self):
|
||||
"""
|
||||
Sets the label's vertical position anchor This anchor binds the
|
||||
specified `textposition` to the "top", "middle" or "bottom" of
|
||||
the label text. For example, if `textposition` is set to *top
|
||||
right* and `yanchor` to "top" then the top-most portion of the
|
||||
label text lines up with the top-most edge of the shape.
|
||||
|
||||
The 'yanchor' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['top', 'middle', 'bottom']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["yanchor"]
|
||||
|
||||
@yanchor.setter
|
||||
def yanchor(self, val):
|
||||
self["yanchor"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets the shape label text font.
|
||||
padding
|
||||
Sets padding (in px) between edge of label and edge of
|
||||
shape.
|
||||
text
|
||||
Sets the text to display with shape. It is also used
|
||||
for legend item if `name` is not provided.
|
||||
textangle
|
||||
Sets the angle at which the label text is drawn with
|
||||
respect to the horizontal. For lines, angle "auto" is
|
||||
the same angle as the line. For all other shapes, angle
|
||||
"auto" is horizontal.
|
||||
textposition
|
||||
Sets the position of the label text relative to the
|
||||
shape. Supported values for rectangles, circles and
|
||||
paths are *top left*, *top center*, *top right*,
|
||||
*middle left*, *middle center*, *middle right*, *bottom
|
||||
left*, *bottom center*, and *bottom right*. Supported
|
||||
values for lines are "start", "middle", and "end".
|
||||
Default: *middle center* for rectangles, circles, and
|
||||
paths; "middle" for lines.
|
||||
texttemplate
|
||||
Template string used for rendering the shape's label.
|
||||
Note that this will override `text`. Variables are
|
||||
inserted using %{variable}, for example "x0: %{x0}".
|
||||
Numbers are formatted using d3-format's syntax
|
||||
%{variable:d3-format}, for example "Price: %{x0:$.2f}".
|
||||
See
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day: %{x0|%m
|
||||
%b %Y}". See https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax. A single multiplication or
|
||||
division operation may be applied to numeric variables,
|
||||
and combined with d3 number formatting, for example
|
||||
"Length in cm: %{x0*2.54}", "%{slope*60:.1f} meters per
|
||||
second." For log axes, variable values are given in log
|
||||
units. For date axes, x/y coordinate variables and
|
||||
center variables use datetimes, while all other
|
||||
variable values use values in ms. Finally, the template
|
||||
string has access to variables `x0`, `x1`, `y0`, `y1`,
|
||||
`slope`, `dx`, `dy`, `width`, `height`, `length`,
|
||||
`xcenter` and `ycenter`.
|
||||
xanchor
|
||||
Sets the label's horizontal position anchor This anchor
|
||||
binds the specified `textposition` to the "left",
|
||||
"center" or "right" of the label text. For example, if
|
||||
`textposition` is set to *top right* and `xanchor` to
|
||||
"right" then the right-most portion of the label text
|
||||
lines up with the right-most edge of the shape.
|
||||
yanchor
|
||||
Sets the label's vertical position anchor This anchor
|
||||
binds the specified `textposition` to the "top",
|
||||
"middle" or "bottom" of the label text. For example, if
|
||||
`textposition` is set to *top right* and `yanchor` to
|
||||
"top" then the top-most portion of the label text lines
|
||||
up with the top-most edge of the shape.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
font=None,
|
||||
padding=None,
|
||||
text=None,
|
||||
textangle=None,
|
||||
textposition=None,
|
||||
texttemplate=None,
|
||||
xanchor=None,
|
||||
yanchor=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Label object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.shape.Label`
|
||||
font
|
||||
Sets the shape label text font.
|
||||
padding
|
||||
Sets padding (in px) between edge of label and edge of
|
||||
shape.
|
||||
text
|
||||
Sets the text to display with shape. It is also used
|
||||
for legend item if `name` is not provided.
|
||||
textangle
|
||||
Sets the angle at which the label text is drawn with
|
||||
respect to the horizontal. For lines, angle "auto" is
|
||||
the same angle as the line. For all other shapes, angle
|
||||
"auto" is horizontal.
|
||||
textposition
|
||||
Sets the position of the label text relative to the
|
||||
shape. Supported values for rectangles, circles and
|
||||
paths are *top left*, *top center*, *top right*,
|
||||
*middle left*, *middle center*, *middle right*, *bottom
|
||||
left*, *bottom center*, and *bottom right*. Supported
|
||||
values for lines are "start", "middle", and "end".
|
||||
Default: *middle center* for rectangles, circles, and
|
||||
paths; "middle" for lines.
|
||||
texttemplate
|
||||
Template string used for rendering the shape's label.
|
||||
Note that this will override `text`. Variables are
|
||||
inserted using %{variable}, for example "x0: %{x0}".
|
||||
Numbers are formatted using d3-format's syntax
|
||||
%{variable:d3-format}, for example "Price: %{x0:$.2f}".
|
||||
See
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day: %{x0|%m
|
||||
%b %Y}". See https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax. A single multiplication or
|
||||
division operation may be applied to numeric variables,
|
||||
and combined with d3 number formatting, for example
|
||||
"Length in cm: %{x0*2.54}", "%{slope*60:.1f} meters per
|
||||
second." For log axes, variable values are given in log
|
||||
units. For date axes, x/y coordinate variables and
|
||||
center variables use datetimes, while all other
|
||||
variable values use values in ms. Finally, the template
|
||||
string has access to variables `x0`, `x1`, `y0`, `y1`,
|
||||
`slope`, `dx`, `dy`, `width`, `height`, `length`,
|
||||
`xcenter` and `ycenter`.
|
||||
xanchor
|
||||
Sets the label's horizontal position anchor This anchor
|
||||
binds the specified `textposition` to the "left",
|
||||
"center" or "right" of the label text. For example, if
|
||||
`textposition` is set to *top right* and `xanchor` to
|
||||
"right" then the right-most portion of the label text
|
||||
lines up with the right-most edge of the shape.
|
||||
yanchor
|
||||
Sets the label's vertical position anchor This anchor
|
||||
binds the specified `textposition` to the "top",
|
||||
"middle" or "bottom" of the label text. For example, if
|
||||
`textposition` is set to *top right* and `yanchor` to
|
||||
"top" then the top-most portion of the label text lines
|
||||
up with the top-most edge of the shape.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Label
|
||||
"""
|
||||
super().__init__("label")
|
||||
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.layout.shape.Label
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.shape.Label`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("padding", arg, padding)
|
||||
self._set_property("text", arg, text)
|
||||
self._set_property("textangle", arg, textangle)
|
||||
self._set_property("textposition", arg, textposition)
|
||||
self._set_property("texttemplate", arg, texttemplate)
|
||||
self._set_property("xanchor", arg, xanchor)
|
||||
self._set_property("yanchor", arg, yanchor)
|
||||
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 BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Legendgrouptitle(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.shape"
|
||||
_path_str = "layout.shape.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.layout.shape.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.shape.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.layout.shape.L
|
||||
egendgrouptitle`
|
||||
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.layout.shape.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.shape.Legendgrouptitle`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,139 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Line(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.shape"
|
||||
_path_str = "layout.shape.line"
|
||||
_valid_props = {"color", "dash", "width"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the line color.
|
||||
|
||||
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 dash(self):
|
||||
"""
|
||||
Sets the dash style of lines. Set to a dash type string
|
||||
("solid", "dot", "dash", "longdash", "dashdot", or
|
||||
"longdashdot") or a dash length list in px (eg
|
||||
"5px,10px,2px,2px").
|
||||
|
||||
The 'dash' property is an enumeration that may be specified as:
|
||||
- One of the following dash styles:
|
||||
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
|
||||
- A string containing a dash length list in pixels or percentages
|
||||
(e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["dash"]
|
||||
|
||||
@dash.setter
|
||||
def dash(self, val):
|
||||
self["dash"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the line width (in px).
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the line color.
|
||||
dash
|
||||
Sets the dash style of lines. Set to a dash type string
|
||||
("solid", "dot", "dash", "longdash", "dashdot", or
|
||||
"longdashdot") or a dash length list in px (eg
|
||||
"5px,10px,2px,2px").
|
||||
width
|
||||
Sets the line width (in px).
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
|
||||
"""
|
||||
Construct a new Line object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.shape.Line`
|
||||
color
|
||||
Sets the line color.
|
||||
dash
|
||||
Sets the dash style of lines. Set to a dash type string
|
||||
("solid", "dot", "dash", "longdash", "dashdot", or
|
||||
"longdashdot") or a dash length list in px (eg
|
||||
"5px,10px,2px,2px").
|
||||
width
|
||||
Sets the line width (in px).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Line
|
||||
"""
|
||||
super().__init__("line")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.layout.shape.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.shape.Line`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("dash", arg, dash)
|
||||
self._set_property("width", arg, width)
|
||||
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 BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.shape.label"
|
||||
_path_str = "layout.shape.label.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 the shape label text font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.shape.label.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.layout.shape.label.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.shape.label.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 BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.shape.legendgrouptitle"
|
||||
_path_str = "layout.shape.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.layout.shape.l
|
||||
egendgrouptitle.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.layout.shape.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.shape.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