done
This commit is contained in:
@ -0,0 +1,28 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._autorangeoptions import Autorangeoptions
|
||||
from ._minor import Minor
|
||||
from ._rangebreak import Rangebreak
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from ._unifiedhovertitle import Unifiedhovertitle
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
[
|
||||
"._autorangeoptions.Autorangeoptions",
|
||||
"._minor.Minor",
|
||||
"._rangebreak.Rangebreak",
|
||||
"._tickfont.Tickfont",
|
||||
"._tickformatstop.Tickformatstop",
|
||||
"._title.Title",
|
||||
"._unifiedhovertitle.Unifiedhovertitle",
|
||||
],
|
||||
)
|
@ -0,0 +1,216 @@
|
||||
# --- 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 Autorangeoptions(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.autorangeoptions"
|
||||
_valid_props = {
|
||||
"clipmax",
|
||||
"clipmin",
|
||||
"include",
|
||||
"includesrc",
|
||||
"maxallowed",
|
||||
"minallowed",
|
||||
}
|
||||
|
||||
@property
|
||||
def clipmax(self):
|
||||
"""
|
||||
Clip autorange maximum if it goes beyond this value. Has no
|
||||
effect when `autorangeoptions.maxallowed` is provided.
|
||||
|
||||
The 'clipmax' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["clipmax"]
|
||||
|
||||
@clipmax.setter
|
||||
def clipmax(self, val):
|
||||
self["clipmax"] = val
|
||||
|
||||
@property
|
||||
def clipmin(self):
|
||||
"""
|
||||
Clip autorange minimum if it goes beyond this value. Has no
|
||||
effect when `autorangeoptions.minallowed` is provided.
|
||||
|
||||
The 'clipmin' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["clipmin"]
|
||||
|
||||
@clipmin.setter
|
||||
def clipmin(self, val):
|
||||
self["clipmin"] = val
|
||||
|
||||
@property
|
||||
def include(self):
|
||||
"""
|
||||
Ensure this value is included in autorange.
|
||||
|
||||
The 'include' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["include"]
|
||||
|
||||
@include.setter
|
||||
def include(self, val):
|
||||
self["include"] = val
|
||||
|
||||
@property
|
||||
def includesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `include`.
|
||||
|
||||
The 'includesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["includesrc"]
|
||||
|
||||
@includesrc.setter
|
||||
def includesrc(self, val):
|
||||
self["includesrc"] = val
|
||||
|
||||
@property
|
||||
def maxallowed(self):
|
||||
"""
|
||||
Use this value exactly as autorange maximum.
|
||||
|
||||
The 'maxallowed' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["maxallowed"]
|
||||
|
||||
@maxallowed.setter
|
||||
def maxallowed(self, val):
|
||||
self["maxallowed"] = val
|
||||
|
||||
@property
|
||||
def minallowed(self):
|
||||
"""
|
||||
Use this value exactly as autorange minimum.
|
||||
|
||||
The 'minallowed' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["minallowed"]
|
||||
|
||||
@minallowed.setter
|
||||
def minallowed(self, val):
|
||||
self["minallowed"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
clipmax
|
||||
Clip autorange maximum if it goes beyond this value.
|
||||
Has no effect when `autorangeoptions.maxallowed` is
|
||||
provided.
|
||||
clipmin
|
||||
Clip autorange minimum if it goes beyond this value.
|
||||
Has no effect when `autorangeoptions.minallowed` is
|
||||
provided.
|
||||
include
|
||||
Ensure this value is included in autorange.
|
||||
includesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`include`.
|
||||
maxallowed
|
||||
Use this value exactly as autorange maximum.
|
||||
minallowed
|
||||
Use this value exactly as autorange minimum.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
clipmax=None,
|
||||
clipmin=None,
|
||||
include=None,
|
||||
includesrc=None,
|
||||
maxallowed=None,
|
||||
minallowed=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Autorangeoptions object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.A
|
||||
utorangeoptions`
|
||||
clipmax
|
||||
Clip autorange maximum if it goes beyond this value.
|
||||
Has no effect when `autorangeoptions.maxallowed` is
|
||||
provided.
|
||||
clipmin
|
||||
Clip autorange minimum if it goes beyond this value.
|
||||
Has no effect when `autorangeoptions.minallowed` is
|
||||
provided.
|
||||
include
|
||||
Ensure this value is included in autorange.
|
||||
includesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`include`.
|
||||
maxallowed
|
||||
Use this value exactly as autorange maximum.
|
||||
minallowed
|
||||
Use this value exactly as autorange minimum.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Autorangeoptions
|
||||
"""
|
||||
super().__init__("autorangeoptions")
|
||||
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.yaxis.Autorangeoptions
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Autorangeoptions`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("clipmax", arg, clipmax)
|
||||
self._set_property("clipmin", arg, clipmin)
|
||||
self._set_property("include", arg, include)
|
||||
self._set_property("includesrc", arg, includesrc)
|
||||
self._set_property("maxallowed", arg, maxallowed)
|
||||
self._set_property("minallowed", arg, minallowed)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,566 @@
|
||||
# --- 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 Minor(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.minor"
|
||||
_valid_props = {
|
||||
"dtick",
|
||||
"gridcolor",
|
||||
"griddash",
|
||||
"gridwidth",
|
||||
"nticks",
|
||||
"showgrid",
|
||||
"tick0",
|
||||
"tickcolor",
|
||||
"ticklen",
|
||||
"tickmode",
|
||||
"ticks",
|
||||
"tickvals",
|
||||
"tickvalssrc",
|
||||
"tickwidth",
|
||||
}
|
||||
|
||||
@property
|
||||
def dtick(self):
|
||||
"""
|
||||
Sets the step in-between ticks on this axis. Use with `tick0`.
|
||||
Must be a positive number, or special strings available to
|
||||
"log" and "date" axes. If the axis `type` is "log", then ticks
|
||||
are set every 10^(n*dtick) where n is the tick number. For
|
||||
example, to set a tick mark at 1, 10, 100, 1000, ... set dtick
|
||||
to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2.
|
||||
To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to
|
||||
log_10(5), or 0.69897000433. "log" has several special values;
|
||||
"L<f>", where `f` is a positive number, gives ticks linearly
|
||||
spaced in value (but not position). For example `tick0` = 0.1,
|
||||
`dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To
|
||||
show powers of 10 plus small digits between, use "D1" (all
|
||||
digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and
|
||||
"D2". If the axis `type` is "date", then you must convert the
|
||||
time to milliseconds. For example, to set the interval between
|
||||
ticks to one day, set `dtick` to 86400000.0. "date" also has
|
||||
special values "M<n>" gives ticks spaced by a number of months.
|
||||
`n` must be a positive integer. To set ticks on the 15th of
|
||||
every third month, set `tick0` to "2000-01-15" and `dtick` to
|
||||
"M3". To set ticks every 4 years, set `dtick` to "M48"
|
||||
|
||||
The 'dtick' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["dtick"]
|
||||
|
||||
@dtick.setter
|
||||
def dtick(self, val):
|
||||
self["dtick"] = val
|
||||
|
||||
@property
|
||||
def gridcolor(self):
|
||||
"""
|
||||
Sets the color of the grid lines.
|
||||
|
||||
The 'gridcolor' 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["gridcolor"]
|
||||
|
||||
@gridcolor.setter
|
||||
def gridcolor(self, val):
|
||||
self["gridcolor"] = val
|
||||
|
||||
@property
|
||||
def griddash(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 'griddash' 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["griddash"]
|
||||
|
||||
@griddash.setter
|
||||
def griddash(self, val):
|
||||
self["griddash"] = val
|
||||
|
||||
@property
|
||||
def gridwidth(self):
|
||||
"""
|
||||
Sets the width (in px) of the grid lines.
|
||||
|
||||
The 'gridwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["gridwidth"]
|
||||
|
||||
@gridwidth.setter
|
||||
def gridwidth(self, val):
|
||||
self["gridwidth"] = val
|
||||
|
||||
@property
|
||||
def nticks(self):
|
||||
"""
|
||||
Specifies the maximum number of ticks for the particular axis.
|
||||
The actual number of ticks will be chosen automatically to be
|
||||
less than or equal to `nticks`. Has an effect only if
|
||||
`tickmode` is set to "auto".
|
||||
|
||||
The 'nticks' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["nticks"]
|
||||
|
||||
@nticks.setter
|
||||
def nticks(self, val):
|
||||
self["nticks"] = val
|
||||
|
||||
@property
|
||||
def showgrid(self):
|
||||
"""
|
||||
Determines whether or not grid lines are drawn. If True, the
|
||||
grid lines are drawn at every tick mark.
|
||||
|
||||
The 'showgrid' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showgrid"]
|
||||
|
||||
@showgrid.setter
|
||||
def showgrid(self, val):
|
||||
self["showgrid"] = val
|
||||
|
||||
@property
|
||||
def tick0(self):
|
||||
"""
|
||||
Sets the placement of the first tick on this axis. Use with
|
||||
`dtick`. If the axis `type` is "log", then you must take the
|
||||
log of your starting tick (e.g. to set the starting tick to
|
||||
100, set the `tick0` to 2) except when `dtick`=*L<f>* (see
|
||||
`dtick` for more info). If the axis `type` is "date", it should
|
||||
be a date string, like date data. If the axis `type` is
|
||||
"category", it should be a number, using the scale where each
|
||||
category is assigned a serial number from zero in the order it
|
||||
appears.
|
||||
|
||||
The 'tick0' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["tick0"]
|
||||
|
||||
@tick0.setter
|
||||
def tick0(self, val):
|
||||
self["tick0"] = val
|
||||
|
||||
@property
|
||||
def tickcolor(self):
|
||||
"""
|
||||
Sets the tick color.
|
||||
|
||||
The 'tickcolor' 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["tickcolor"]
|
||||
|
||||
@tickcolor.setter
|
||||
def tickcolor(self, val):
|
||||
self["tickcolor"] = val
|
||||
|
||||
@property
|
||||
def ticklen(self):
|
||||
"""
|
||||
Sets the tick length (in px).
|
||||
|
||||
The 'ticklen' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["ticklen"]
|
||||
|
||||
@ticklen.setter
|
||||
def ticklen(self, val):
|
||||
self["ticklen"] = val
|
||||
|
||||
@property
|
||||
def tickmode(self):
|
||||
"""
|
||||
Sets the tick mode for this axis. If "auto", the number of
|
||||
ticks is set via `nticks`. If "linear", the placement of the
|
||||
ticks is determined by a starting position `tick0` and a tick
|
||||
step `dtick` ("linear" is the default value if `tick0` and
|
||||
`dtick` are provided). If "array", the placement of the ticks
|
||||
is set via `tickvals` and the tick text is `ticktext`. ("array"
|
||||
is the default value if `tickvals` is provided).
|
||||
|
||||
The 'tickmode' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['auto', 'linear', 'array']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["tickmode"]
|
||||
|
||||
@tickmode.setter
|
||||
def tickmode(self, val):
|
||||
self["tickmode"] = val
|
||||
|
||||
@property
|
||||
def ticks(self):
|
||||
"""
|
||||
Determines whether ticks are drawn or not. If "", this axis'
|
||||
ticks are not drawn. If "outside" ("inside"), this axis' are
|
||||
drawn outside (inside) the axis lines.
|
||||
|
||||
The 'ticks' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['outside', 'inside', '']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["ticks"]
|
||||
|
||||
@ticks.setter
|
||||
def ticks(self, val):
|
||||
self["ticks"] = val
|
||||
|
||||
@property
|
||||
def tickvals(self):
|
||||
"""
|
||||
Sets the values at which ticks on this axis appear. Only has an
|
||||
effect if `tickmode` is set to "array". Used with `ticktext`.
|
||||
|
||||
The 'tickvals' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["tickvals"]
|
||||
|
||||
@tickvals.setter
|
||||
def tickvals(self, val):
|
||||
self["tickvals"] = val
|
||||
|
||||
@property
|
||||
def tickvalssrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `tickvals`.
|
||||
|
||||
The 'tickvalssrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["tickvalssrc"]
|
||||
|
||||
@tickvalssrc.setter
|
||||
def tickvalssrc(self, val):
|
||||
self["tickvalssrc"] = val
|
||||
|
||||
@property
|
||||
def tickwidth(self):
|
||||
"""
|
||||
Sets the tick width (in px).
|
||||
|
||||
The 'tickwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["tickwidth"]
|
||||
|
||||
@tickwidth.setter
|
||||
def tickwidth(self, val):
|
||||
self["tickwidth"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
dtick
|
||||
Sets the step in-between ticks on this axis. Use with
|
||||
`tick0`. Must be a positive number, or special strings
|
||||
available to "log" and "date" axes. If the axis `type`
|
||||
is "log", then ticks are set every 10^(n*dtick) where n
|
||||
is the tick number. For example, to set a tick mark at
|
||||
1, 10, 100, 1000, ... set dtick to 1. To set tick marks
|
||||
at 1, 100, 10000, ... set dtick to 2. To set tick marks
|
||||
at 1, 5, 25, 125, 625, 3125, ... set dtick to
|
||||
log_10(5), or 0.69897000433. "log" has several special
|
||||
values; "L<f>", where `f` is a positive number, gives
|
||||
ticks linearly spaced in value (but not position). For
|
||||
example `tick0` = 0.1, `dtick` = "L0.5" will put ticks
|
||||
at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus
|
||||
small digits between, use "D1" (all digits) or "D2"
|
||||
(only 2 and 5). `tick0` is ignored for "D1" and "D2".
|
||||
If the axis `type` is "date", then you must convert the
|
||||
time to milliseconds. For example, to set the interval
|
||||
between ticks to one day, set `dtick` to 86400000.0.
|
||||
"date" also has special values "M<n>" gives ticks
|
||||
spaced by a number of months. `n` must be a positive
|
||||
integer. To set ticks on the 15th of every third month,
|
||||
set `tick0` to "2000-01-15" and `dtick` to "M3". To set
|
||||
ticks every 4 years, set `dtick` to "M48"
|
||||
gridcolor
|
||||
Sets the color of the grid lines.
|
||||
griddash
|
||||
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").
|
||||
gridwidth
|
||||
Sets the width (in px) of the grid lines.
|
||||
nticks
|
||||
Specifies the maximum number of ticks for the
|
||||
particular axis. The actual number of ticks will be
|
||||
chosen automatically to be less than or equal to
|
||||
`nticks`. Has an effect only if `tickmode` is set to
|
||||
"auto".
|
||||
showgrid
|
||||
Determines whether or not grid lines are drawn. If
|
||||
True, the grid lines are drawn at every tick mark.
|
||||
tick0
|
||||
Sets the placement of the first tick on this axis. Use
|
||||
with `dtick`. If the axis `type` is "log", then you
|
||||
must take the log of your starting tick (e.g. to set
|
||||
the starting tick to 100, set the `tick0` to 2) except
|
||||
when `dtick`=*L<f>* (see `dtick` for more info). If the
|
||||
axis `type` is "date", it should be a date string, like
|
||||
date data. If the axis `type` is "category", it should
|
||||
be a number, using the scale where each category is
|
||||
assigned a serial number from zero in the order it
|
||||
appears.
|
||||
tickcolor
|
||||
Sets the tick color.
|
||||
ticklen
|
||||
Sets the tick length (in px).
|
||||
tickmode
|
||||
Sets the tick mode for this axis. If "auto", the number
|
||||
of ticks is set via `nticks`. If "linear", the
|
||||
placement of the ticks is determined by a starting
|
||||
position `tick0` and a tick step `dtick` ("linear" is
|
||||
the default value if `tick0` and `dtick` are provided).
|
||||
If "array", the placement of the ticks is set via
|
||||
`tickvals` and the tick text is `ticktext`. ("array" is
|
||||
the default value if `tickvals` is provided).
|
||||
ticks
|
||||
Determines whether ticks are drawn or not. If "", this
|
||||
axis' ticks are not drawn. If "outside" ("inside"),
|
||||
this axis' are drawn outside (inside) the axis lines.
|
||||
tickvals
|
||||
Sets the values at which ticks on this axis appear.
|
||||
Only has an effect if `tickmode` is set to "array".
|
||||
Used with `ticktext`.
|
||||
tickvalssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`tickvals`.
|
||||
tickwidth
|
||||
Sets the tick width (in px).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
dtick=None,
|
||||
gridcolor=None,
|
||||
griddash=None,
|
||||
gridwidth=None,
|
||||
nticks=None,
|
||||
showgrid=None,
|
||||
tick0=None,
|
||||
tickcolor=None,
|
||||
ticklen=None,
|
||||
tickmode=None,
|
||||
ticks=None,
|
||||
tickvals=None,
|
||||
tickvalssrc=None,
|
||||
tickwidth=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Minor object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.yaxis.Minor`
|
||||
dtick
|
||||
Sets the step in-between ticks on this axis. Use with
|
||||
`tick0`. Must be a positive number, or special strings
|
||||
available to "log" and "date" axes. If the axis `type`
|
||||
is "log", then ticks are set every 10^(n*dtick) where n
|
||||
is the tick number. For example, to set a tick mark at
|
||||
1, 10, 100, 1000, ... set dtick to 1. To set tick marks
|
||||
at 1, 100, 10000, ... set dtick to 2. To set tick marks
|
||||
at 1, 5, 25, 125, 625, 3125, ... set dtick to
|
||||
log_10(5), or 0.69897000433. "log" has several special
|
||||
values; "L<f>", where `f` is a positive number, gives
|
||||
ticks linearly spaced in value (but not position). For
|
||||
example `tick0` = 0.1, `dtick` = "L0.5" will put ticks
|
||||
at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus
|
||||
small digits between, use "D1" (all digits) or "D2"
|
||||
(only 2 and 5). `tick0` is ignored for "D1" and "D2".
|
||||
If the axis `type` is "date", then you must convert the
|
||||
time to milliseconds. For example, to set the interval
|
||||
between ticks to one day, set `dtick` to 86400000.0.
|
||||
"date" also has special values "M<n>" gives ticks
|
||||
spaced by a number of months. `n` must be a positive
|
||||
integer. To set ticks on the 15th of every third month,
|
||||
set `tick0` to "2000-01-15" and `dtick` to "M3". To set
|
||||
ticks every 4 years, set `dtick` to "M48"
|
||||
gridcolor
|
||||
Sets the color of the grid lines.
|
||||
griddash
|
||||
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").
|
||||
gridwidth
|
||||
Sets the width (in px) of the grid lines.
|
||||
nticks
|
||||
Specifies the maximum number of ticks for the
|
||||
particular axis. The actual number of ticks will be
|
||||
chosen automatically to be less than or equal to
|
||||
`nticks`. Has an effect only if `tickmode` is set to
|
||||
"auto".
|
||||
showgrid
|
||||
Determines whether or not grid lines are drawn. If
|
||||
True, the grid lines are drawn at every tick mark.
|
||||
tick0
|
||||
Sets the placement of the first tick on this axis. Use
|
||||
with `dtick`. If the axis `type` is "log", then you
|
||||
must take the log of your starting tick (e.g. to set
|
||||
the starting tick to 100, set the `tick0` to 2) except
|
||||
when `dtick`=*L<f>* (see `dtick` for more info). If the
|
||||
axis `type` is "date", it should be a date string, like
|
||||
date data. If the axis `type` is "category", it should
|
||||
be a number, using the scale where each category is
|
||||
assigned a serial number from zero in the order it
|
||||
appears.
|
||||
tickcolor
|
||||
Sets the tick color.
|
||||
ticklen
|
||||
Sets the tick length (in px).
|
||||
tickmode
|
||||
Sets the tick mode for this axis. If "auto", the number
|
||||
of ticks is set via `nticks`. If "linear", the
|
||||
placement of the ticks is determined by a starting
|
||||
position `tick0` and a tick step `dtick` ("linear" is
|
||||
the default value if `tick0` and `dtick` are provided).
|
||||
If "array", the placement of the ticks is set via
|
||||
`tickvals` and the tick text is `ticktext`. ("array" is
|
||||
the default value if `tickvals` is provided).
|
||||
ticks
|
||||
Determines whether ticks are drawn or not. If "", this
|
||||
axis' ticks are not drawn. If "outside" ("inside"),
|
||||
this axis' are drawn outside (inside) the axis lines.
|
||||
tickvals
|
||||
Sets the values at which ticks on this axis appear.
|
||||
Only has an effect if `tickmode` is set to "array".
|
||||
Used with `ticktext`.
|
||||
tickvalssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`tickvals`.
|
||||
tickwidth
|
||||
Sets the tick width (in px).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Minor
|
||||
"""
|
||||
super().__init__("minor")
|
||||
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.yaxis.Minor
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Minor`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("dtick", arg, dtick)
|
||||
self._set_property("gridcolor", arg, gridcolor)
|
||||
self._set_property("griddash", arg, griddash)
|
||||
self._set_property("gridwidth", arg, gridwidth)
|
||||
self._set_property("nticks", arg, nticks)
|
||||
self._set_property("showgrid", arg, showgrid)
|
||||
self._set_property("tick0", arg, tick0)
|
||||
self._set_property("tickcolor", arg, tickcolor)
|
||||
self._set_property("ticklen", arg, ticklen)
|
||||
self._set_property("tickmode", arg, tickmode)
|
||||
self._set_property("ticks", arg, ticks)
|
||||
self._set_property("tickvals", arg, tickvals)
|
||||
self._set_property("tickvalssrc", arg, tickvalssrc)
|
||||
self._set_property("tickwidth", arg, tickwidth)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,330 @@
|
||||
# --- 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 Rangebreak(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.rangebreak"
|
||||
_valid_props = {
|
||||
"bounds",
|
||||
"dvalue",
|
||||
"enabled",
|
||||
"name",
|
||||
"pattern",
|
||||
"templateitemname",
|
||||
"values",
|
||||
}
|
||||
|
||||
@property
|
||||
def bounds(self):
|
||||
"""
|
||||
Sets the lower and upper bounds of this axis rangebreak. Can be
|
||||
used with `pattern`.
|
||||
|
||||
The 'bounds' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'bounds[0]' property accepts values of any type
|
||||
(1) The 'bounds[1]' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["bounds"]
|
||||
|
||||
@bounds.setter
|
||||
def bounds(self, val):
|
||||
self["bounds"] = val
|
||||
|
||||
@property
|
||||
def dvalue(self):
|
||||
"""
|
||||
Sets the size of each `values` item. The default is one day in
|
||||
milliseconds.
|
||||
|
||||
The 'dvalue' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["dvalue"]
|
||||
|
||||
@dvalue.setter
|
||||
def dvalue(self, val):
|
||||
self["dvalue"] = val
|
||||
|
||||
@property
|
||||
def enabled(self):
|
||||
"""
|
||||
Determines whether this axis rangebreak is enabled or disabled.
|
||||
Please note that `rangebreaks` only work for "date" axis type.
|
||||
|
||||
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 pattern(self):
|
||||
"""
|
||||
Determines a pattern on the time line that generates breaks. If
|
||||
*day of week* - days of the week in English e.g. 'Sunday' or
|
||||
`sun` (matching is case-insensitive and considers only the
|
||||
first three characters), as well as Sunday-based integers
|
||||
between 0 and 6. If "hour" - hour (24-hour clock) as decimal
|
||||
numbers between 0 and 24. for more info. Examples: - { pattern:
|
||||
'day of week', bounds: [6, 1] } or simply { bounds: ['sat',
|
||||
'mon'] } breaks from Saturday to Monday (i.e. skips the
|
||||
weekends). - { pattern: 'hour', bounds: [17, 8] } breaks from
|
||||
5pm to 8am (i.e. skips non-work hours).
|
||||
|
||||
The 'pattern' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['day of week', 'hour', '']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["pattern"]
|
||||
|
||||
@pattern.setter
|
||||
def pattern(self, val):
|
||||
self["pattern"] = 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 values(self):
|
||||
"""
|
||||
Sets the coordinate values corresponding to the rangebreaks. An
|
||||
alternative to `bounds`. Use `dvalue` to set the size of the
|
||||
values along the axis.
|
||||
|
||||
The 'values' property is an info array that may be specified as:
|
||||
* a list of elements where:
|
||||
The 'values[i]' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["values"]
|
||||
|
||||
@values.setter
|
||||
def values(self, val):
|
||||
self["values"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
bounds
|
||||
Sets the lower and upper bounds of this axis
|
||||
rangebreak. Can be used with `pattern`.
|
||||
dvalue
|
||||
Sets the size of each `values` item. The default is one
|
||||
day in milliseconds.
|
||||
enabled
|
||||
Determines whether this axis rangebreak is enabled or
|
||||
disabled. Please note that `rangebreaks` only work for
|
||||
"date" axis type.
|
||||
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.
|
||||
pattern
|
||||
Determines a pattern on the time line that generates
|
||||
breaks. If *day of week* - days of the week in English
|
||||
e.g. 'Sunday' or `sun` (matching is case-insensitive
|
||||
and considers only the first three characters), as well
|
||||
as Sunday-based integers between 0 and 6. If "hour" -
|
||||
hour (24-hour clock) as decimal numbers between 0 and
|
||||
24. for more info. Examples: - { pattern: 'day of
|
||||
week', bounds: [6, 1] } or simply { bounds: ['sat',
|
||||
'mon'] } breaks from Saturday to Monday (i.e. skips
|
||||
the weekends). - { pattern: 'hour', bounds: [17, 8] }
|
||||
breaks from 5pm to 8am (i.e. skips non-work hours).
|
||||
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`.
|
||||
values
|
||||
Sets the coordinate values corresponding to the
|
||||
rangebreaks. An alternative to `bounds`. Use `dvalue`
|
||||
to set the size of the values along the axis.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
bounds=None,
|
||||
dvalue=None,
|
||||
enabled=None,
|
||||
name=None,
|
||||
pattern=None,
|
||||
templateitemname=None,
|
||||
values=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Rangebreak object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.yaxis.Rangebreak`
|
||||
bounds
|
||||
Sets the lower and upper bounds of this axis
|
||||
rangebreak. Can be used with `pattern`.
|
||||
dvalue
|
||||
Sets the size of each `values` item. The default is one
|
||||
day in milliseconds.
|
||||
enabled
|
||||
Determines whether this axis rangebreak is enabled or
|
||||
disabled. Please note that `rangebreaks` only work for
|
||||
"date" axis type.
|
||||
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.
|
||||
pattern
|
||||
Determines a pattern on the time line that generates
|
||||
breaks. If *day of week* - days of the week in English
|
||||
e.g. 'Sunday' or `sun` (matching is case-insensitive
|
||||
and considers only the first three characters), as well
|
||||
as Sunday-based integers between 0 and 6. If "hour" -
|
||||
hour (24-hour clock) as decimal numbers between 0 and
|
||||
24. for more info. Examples: - { pattern: 'day of
|
||||
week', bounds: [6, 1] } or simply { bounds: ['sat',
|
||||
'mon'] } breaks from Saturday to Monday (i.e. skips
|
||||
the weekends). - { pattern: 'hour', bounds: [17, 8] }
|
||||
breaks from 5pm to 8am (i.e. skips non-work hours).
|
||||
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`.
|
||||
values
|
||||
Sets the coordinate values corresponding to the
|
||||
rangebreaks. An alternative to `bounds`. Use `dvalue`
|
||||
to set the size of the values along the axis.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Rangebreak
|
||||
"""
|
||||
super().__init__("rangebreaks")
|
||||
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.yaxis.Rangebreak
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Rangebreak`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("bounds", arg, bounds)
|
||||
self._set_property("dvalue", arg, dvalue)
|
||||
self._set_property("enabled", arg, enabled)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("pattern", arg, pattern)
|
||||
self._set_property("templateitemname", arg, templateitemname)
|
||||
self._set_property("values", arg, values)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.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.layout.yaxis.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.layout.yaxis.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.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 BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickformatstop(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.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.layout.yaxis.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.layout.yaxis.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.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,150 @@
|
||||
# --- 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 Title(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.title"
|
||||
_valid_props = {"font", "standoff", "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.layout.yaxis.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.yaxis.title.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def standoff(self):
|
||||
"""
|
||||
Sets the standoff distance (in px) between the axis labels and
|
||||
the title text The default value is a function of the axis tick
|
||||
labels, the title `font.size` and the axis `linewidth`. Note
|
||||
that the axis title position is always constrained within the
|
||||
margins, so the actual standoff distance is always less than
|
||||
the set or default value. By setting `standoff` and turning on
|
||||
`automargin`, plotly.js will push the margins to fit the axis
|
||||
title at given standoff distance.
|
||||
|
||||
The 'standoff' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["standoff"]
|
||||
|
||||
@standoff.setter
|
||||
def standoff(self, val):
|
||||
self["standoff"] = 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.
|
||||
standoff
|
||||
Sets the standoff distance (in px) between the axis
|
||||
labels and the title text The default value is a
|
||||
function of the axis tick labels, the title `font.size`
|
||||
and the axis `linewidth`. Note that the axis title
|
||||
position is always constrained within the margins, so
|
||||
the actual standoff distance is always less than the
|
||||
set or default value. By setting `standoff` and turning
|
||||
on `automargin`, plotly.js will push the margins to fit
|
||||
the axis title at given standoff distance.
|
||||
text
|
||||
Sets the title of this axis.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, standoff=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.layout.yaxis.Title`
|
||||
font
|
||||
Sets this axis' title font.
|
||||
standoff
|
||||
Sets the standoff distance (in px) between the axis
|
||||
labels and the title text The default value is a
|
||||
function of the axis tick labels, the title `font.size`
|
||||
and the axis `linewidth`. Note that the axis title
|
||||
position is always constrained within the margins, so
|
||||
the actual standoff distance is always less than the
|
||||
set or default value. By setting `standoff` and turning
|
||||
on `automargin`, plotly.js will push the margins to fit
|
||||
the axis title at given standoff distance.
|
||||
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.layout.yaxis.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Title`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("standoff", arg, standoff)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
@ -0,0 +1,110 @@
|
||||
# --- 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 Unifiedhovertitle(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.unifiedhovertitle"
|
||||
_valid_props = {"text"}
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Template string used for rendering the title that appear on x
|
||||
or y unified hover box. Variables are inserted using
|
||||
%{variable}, for example "y: %{y}". Numbers are formatted using
|
||||
d3-format's syntax %{variable:d3-format}, for example "Price:
|
||||
%{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
|
||||
details on the formatting syntax. Dates are formatted using
|
||||
d3-time-format's syntax %{variable|d3-time-format}, for example
|
||||
"Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the date
|
||||
formatting syntax.
|
||||
|
||||
The '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 """\
|
||||
text
|
||||
Template string used for rendering the title that
|
||||
appear on x or y unified hover box. Variables are
|
||||
inserted using %{variable}, for example "y: %{y}".
|
||||
Numbers are formatted using d3-format's syntax
|
||||
%{variable:d3-format}, for example "Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day:
|
||||
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, text=None, **kwargs):
|
||||
"""
|
||||
Construct a new Unifiedhovertitle object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.U
|
||||
nifiedhovertitle`
|
||||
text
|
||||
Template string used for rendering the title that
|
||||
appear on x or y unified hover box. Variables are
|
||||
inserted using %{variable}, for example "y: %{y}".
|
||||
Numbers are formatted using d3-format's syntax
|
||||
%{variable:d3-format}, for example "Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day:
|
||||
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Unifiedhovertitle
|
||||
"""
|
||||
super().__init__("unifiedhovertitle")
|
||||
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.yaxis.Unifiedhovertitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Unifiedhovertitle`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
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 BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.yaxis.title"
|
||||
_path_str = "layout.yaxis.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.layout.yaxis.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.layout.yaxis.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.title.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
Reference in New Issue
Block a user