mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-07-01 22:13:01 +00:00
first commit
This commit is contained in:
Ayxan
@ -0,0 +1,24 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or TYPE_CHECKING:
|
||||
from ._minor import Minor
|
||||
from ._rangebreak import Rangebreak
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
[
|
||||
"._minor.Minor",
|
||||
"._rangebreak.Rangebreak",
|
||||
"._tickfont.Tickfont",
|
||||
"._tickformatstop.Tickformatstop",
|
||||
"._title.Title",
|
||||
],
|
||||
)
|
||||
723
.venv/Lib/site-packages/plotly/graph_objs/layout/yaxis/_minor.py
Normal file
723
.venv/Lib/site-packages/plotly/graph_objs/layout/yaxis/_minor.py
Normal file
@ -0,0 +1,723 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Minor(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_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",
|
||||
}
|
||||
|
||||
# dtick
|
||||
# -----
|
||||
@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
|
||||
|
||||
# gridcolor
|
||||
# ---------
|
||||
@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:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["gridcolor"]
|
||||
|
||||
@gridcolor.setter
|
||||
def gridcolor(self, val):
|
||||
self["gridcolor"] = val
|
||||
|
||||
# griddash
|
||||
# --------
|
||||
@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
|
||||
|
||||
# gridwidth
|
||||
# ---------
|
||||
@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
|
||||
|
||||
# nticks
|
||||
# ------
|
||||
@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
|
||||
|
||||
# showgrid
|
||||
# --------
|
||||
@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
|
||||
|
||||
# tick0
|
||||
# -----
|
||||
@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
|
||||
|
||||
# tickcolor
|
||||
# ---------
|
||||
@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:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["tickcolor"]
|
||||
|
||||
@tickcolor.setter
|
||||
def tickcolor(self, val):
|
||||
self["tickcolor"] = val
|
||||
|
||||
# ticklen
|
||||
# -------
|
||||
@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
|
||||
|
||||
# tickmode
|
||||
# --------
|
||||
@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
|
||||
|
||||
# ticks
|
||||
# -----
|
||||
@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
|
||||
|
||||
# tickvals
|
||||
# --------
|
||||
@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
|
||||
|
||||
# tickvalssrc
|
||||
# -----------
|
||||
@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
|
||||
|
||||
# tickwidth
|
||||
# ---------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@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(Minor, self).__init__("minor")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError(
|
||||
"""\
|
||||
The first argument to the plotly.graph_objs.layout.yaxis.Minor
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Minor`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("dtick", None)
|
||||
_v = dtick if dtick is not None else _v
|
||||
if _v is not None:
|
||||
self["dtick"] = _v
|
||||
_v = arg.pop("gridcolor", None)
|
||||
_v = gridcolor if gridcolor is not None else _v
|
||||
if _v is not None:
|
||||
self["gridcolor"] = _v
|
||||
_v = arg.pop("griddash", None)
|
||||
_v = griddash if griddash is not None else _v
|
||||
if _v is not None:
|
||||
self["griddash"] = _v
|
||||
_v = arg.pop("gridwidth", None)
|
||||
_v = gridwidth if gridwidth is not None else _v
|
||||
if _v is not None:
|
||||
self["gridwidth"] = _v
|
||||
_v = arg.pop("nticks", None)
|
||||
_v = nticks if nticks is not None else _v
|
||||
if _v is not None:
|
||||
self["nticks"] = _v
|
||||
_v = arg.pop("showgrid", None)
|
||||
_v = showgrid if showgrid is not None else _v
|
||||
if _v is not None:
|
||||
self["showgrid"] = _v
|
||||
_v = arg.pop("tick0", None)
|
||||
_v = tick0 if tick0 is not None else _v
|
||||
if _v is not None:
|
||||
self["tick0"] = _v
|
||||
_v = arg.pop("tickcolor", None)
|
||||
_v = tickcolor if tickcolor is not None else _v
|
||||
if _v is not None:
|
||||
self["tickcolor"] = _v
|
||||
_v = arg.pop("ticklen", None)
|
||||
_v = ticklen if ticklen is not None else _v
|
||||
if _v is not None:
|
||||
self["ticklen"] = _v
|
||||
_v = arg.pop("tickmode", None)
|
||||
_v = tickmode if tickmode is not None else _v
|
||||
if _v is not None:
|
||||
self["tickmode"] = _v
|
||||
_v = arg.pop("ticks", None)
|
||||
_v = ticks if ticks is not None else _v
|
||||
if _v is not None:
|
||||
self["ticks"] = _v
|
||||
_v = arg.pop("tickvals", None)
|
||||
_v = tickvals if tickvals is not None else _v
|
||||
if _v is not None:
|
||||
self["tickvals"] = _v
|
||||
_v = arg.pop("tickvalssrc", None)
|
||||
_v = tickvalssrc if tickvalssrc is not None else _v
|
||||
if _v is not None:
|
||||
self["tickvalssrc"] = _v
|
||||
_v = arg.pop("tickwidth", None)
|
||||
_v = tickwidth if tickwidth is not None else _v
|
||||
if _v is not None:
|
||||
self["tickwidth"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,382 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Rangebreak(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.rangebreak"
|
||||
_valid_props = {
|
||||
"bounds",
|
||||
"dvalue",
|
||||
"enabled",
|
||||
"name",
|
||||
"pattern",
|
||||
"templateitemname",
|
||||
"values",
|
||||
}
|
||||
|
||||
# bounds
|
||||
# ------
|
||||
@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
|
||||
|
||||
# dvalue
|
||||
# ------
|
||||
@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
|
||||
|
||||
# enabled
|
||||
# -------
|
||||
@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
|
||||
|
||||
# name
|
||||
# ----
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
When used in a template, named items are created in the output
|
||||
figure in addition to any items the figure already has in this
|
||||
array. You can modify these items in the output figure by
|
||||
making your own item with `templateitemname` matching this
|
||||
`name` alongside your modifications (including `visible: false`
|
||||
or `enabled: false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
# pattern
|
||||
# -------
|
||||
@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
|
||||
|
||||
# templateitemname
|
||||
# ----------------
|
||||
@property
|
||||
def templateitemname(self):
|
||||
"""
|
||||
Used to refer to a named item in this array in the template.
|
||||
Named items from the template will be created even without a
|
||||
matching item in the input figure, but you can modify one by
|
||||
making an item with `templateitemname` matching its `name`,
|
||||
alongside your modifications (including `visible: false` or
|
||||
`enabled: false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you explicitly
|
||||
show it with `visible: true`.
|
||||
|
||||
The 'templateitemname' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["templateitemname"]
|
||||
|
||||
@templateitemname.setter
|
||||
def templateitemname(self, val):
|
||||
self["templateitemname"] = val
|
||||
|
||||
# values
|
||||
# ------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@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(Rangebreak, self).__init__("rangebreaks")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError(
|
||||
"""\
|
||||
The first argument to the plotly.graph_objs.layout.yaxis.Rangebreak
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Rangebreak`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("bounds", None)
|
||||
_v = bounds if bounds is not None else _v
|
||||
if _v is not None:
|
||||
self["bounds"] = _v
|
||||
_v = arg.pop("dvalue", None)
|
||||
_v = dvalue if dvalue is not None else _v
|
||||
if _v is not None:
|
||||
self["dvalue"] = _v
|
||||
_v = arg.pop("enabled", None)
|
||||
_v = enabled if enabled is not None else _v
|
||||
if _v is not None:
|
||||
self["enabled"] = _v
|
||||
_v = arg.pop("name", None)
|
||||
_v = name if name is not None else _v
|
||||
if _v is not None:
|
||||
self["name"] = _v
|
||||
_v = arg.pop("pattern", None)
|
||||
_v = pattern if pattern is not None else _v
|
||||
if _v is not None:
|
||||
self["pattern"] = _v
|
||||
_v = arg.pop("templateitemname", None)
|
||||
_v = templateitemname if templateitemname is not None else _v
|
||||
if _v is not None:
|
||||
self["templateitemname"] = _v
|
||||
_v = arg.pop("values", None)
|
||||
_v = values if values is not None else _v
|
||||
if _v is not None:
|
||||
self["values"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,227 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.tickfont"
|
||||
_valid_props = {"color", "family", "size"}
|
||||
|
||||
# color
|
||||
# -----
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
# family
|
||||
# ------
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser will only be able to apply a font if
|
||||
it is available on the system which it operates. Provide
|
||||
multiple font families, separated by commas, to indicate the
|
||||
preference in which to apply fonts if they aren't available on
|
||||
the system. The Chart Studio Cloud (at https://chart-
|
||||
studio.plotly.com or on-premise) generates images on a server,
|
||||
where only a select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto", "Courier New",
|
||||
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
# size
|
||||
# ----
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, family=None, size=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 will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
|
||||
Returns
|
||||
-------
|
||||
Tickfont
|
||||
"""
|
||||
super(Tickfont, self).__init__("tickfont")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError(
|
||||
"""\
|
||||
The first argument to the plotly.graph_objs.layout.yaxis.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("color", None)
|
||||
_v = color if color is not None else _v
|
||||
if _v is not None:
|
||||
self["color"] = _v
|
||||
_v = arg.pop("family", None)
|
||||
_v = family if family is not None else _v
|
||||
if _v is not None:
|
||||
self["family"] = _v
|
||||
_v = arg.pop("size", None)
|
||||
_v = size if size is not None else _v
|
||||
if _v is not None:
|
||||
self["size"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,283 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickformatstop(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.tickformatstop"
|
||||
_valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"}
|
||||
|
||||
# dtickrange
|
||||
# ----------
|
||||
@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
|
||||
|
||||
# enabled
|
||||
# -------
|
||||
@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
|
||||
|
||||
# name
|
||||
# ----
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
When used in a template, named items are created in the output
|
||||
figure in addition to any items the figure already has in this
|
||||
array. You can modify these items in the output figure by
|
||||
making your own item with `templateitemname` matching this
|
||||
`name` alongside your modifications (including `visible: false`
|
||||
or `enabled: false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
# templateitemname
|
||||
# ----------------
|
||||
@property
|
||||
def templateitemname(self):
|
||||
"""
|
||||
Used to refer to a named item in this array in the template.
|
||||
Named items from the template will be created even without a
|
||||
matching item in the input figure, but you can modify one by
|
||||
making an item with `templateitemname` matching its `name`,
|
||||
alongside your modifications (including `visible: false` or
|
||||
`enabled: false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you explicitly
|
||||
show it with `visible: true`.
|
||||
|
||||
The 'templateitemname' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["templateitemname"]
|
||||
|
||||
@templateitemname.setter
|
||||
def templateitemname(self, val):
|
||||
self["templateitemname"] = val
|
||||
|
||||
# value
|
||||
# -----
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@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(Tickformatstop, self).__init__("tickformatstops")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError(
|
||||
"""\
|
||||
The first argument to the plotly.graph_objs.layout.yaxis.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Tickformatstop`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("dtickrange", None)
|
||||
_v = dtickrange if dtickrange is not None else _v
|
||||
if _v is not None:
|
||||
self["dtickrange"] = _v
|
||||
_v = arg.pop("enabled", None)
|
||||
_v = enabled if enabled is not None else _v
|
||||
if _v is not None:
|
||||
self["enabled"] = _v
|
||||
_v = arg.pop("name", None)
|
||||
_v = name if name is not None else _v
|
||||
if _v is not None:
|
||||
self["name"] = _v
|
||||
_v = arg.pop("templateitemname", None)
|
||||
_v = templateitemname if templateitemname is not None else _v
|
||||
if _v is not None:
|
||||
self["templateitemname"] = _v
|
||||
_v = arg.pop("value", None)
|
||||
_v = value if value is not None else _v
|
||||
if _v is not None:
|
||||
self["value"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
218
.venv/Lib/site-packages/plotly/graph_objs/layout/yaxis/_title.py
Normal file
218
.venv/Lib/site-packages/plotly/graph_objs/layout/yaxis/_title.py
Normal file
@ -0,0 +1,218 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Title(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.yaxis"
|
||||
_path_str = "layout.yaxis.title"
|
||||
_valid_props = {"font", "standoff", "text"}
|
||||
|
||||
# font
|
||||
# ----
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this axis' title font. Note that the title's font used to
|
||||
be customized by the now deprecated `titlefont` attribute.
|
||||
|
||||
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
|
||||
|
||||
Supported dict properties:
|
||||
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be
|
||||
applied by the web browser. The web browser
|
||||
will only be able to apply a font if it is
|
||||
available on the system which it operates.
|
||||
Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to
|
||||
apply fonts if they aren't available on the
|
||||
system. The Chart Studio Cloud (at
|
||||
https://chart-studio.plotly.com or on-premise)
|
||||
generates images on a server, where only a
|
||||
select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto",
|
||||
"Courier New", "Droid Sans",, "Droid Serif",
|
||||
"Droid Sans Mono", "Gravitas One", "Old
|
||||
Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.yaxis.title.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
# standoff
|
||||
# --------
|
||||
@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
|
||||
|
||||
# text
|
||||
# ----
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of this axis. Note that before the existence of
|
||||
`title.text`, the title's contents used to be defined as the
|
||||
`title` attribute itself. This behavior has been deprecated.
|
||||
|
||||
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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets this axis' title font. Note that the title's font
|
||||
used to be customized by the now deprecated `titlefont`
|
||||
attribute.
|
||||
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. Note that before the
|
||||
existence of `title.text`, the title's contents used to
|
||||
be defined as the `title` attribute itself. This
|
||||
behavior has been deprecated.
|
||||
"""
|
||||
|
||||
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. Note that the title's font
|
||||
used to be customized by the now deprecated `titlefont`
|
||||
attribute.
|
||||
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. Note that before the
|
||||
existence of `title.text`, the title's contents used to
|
||||
be defined as the `title` attribute itself. This
|
||||
behavior has been deprecated.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Title
|
||||
"""
|
||||
super(Title, self).__init__("title")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError(
|
||||
"""\
|
||||
The first argument to the plotly.graph_objs.layout.yaxis.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.Title`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("font", None)
|
||||
_v = font if font is not None else _v
|
||||
if _v is not None:
|
||||
self["font"] = _v
|
||||
_v = arg.pop("standoff", None)
|
||||
_v = standoff if standoff is not None else _v
|
||||
if _v is not None:
|
||||
self["standoff"] = _v
|
||||
_v = arg.pop("text", None)
|
||||
_v = text if text is not None else _v
|
||||
if _v is not None:
|
||||
self["text"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
@ -0,0 +1,228 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.yaxis.title"
|
||||
_path_str = "layout.yaxis.title.font"
|
||||
_valid_props = {"color", "family", "size"}
|
||||
|
||||
# color
|
||||
# -----
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color:
|
||||
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
||||
beige, bisque, black, blanchedalmond, blue,
|
||||
blueviolet, brown, burlywood, cadetblue,
|
||||
chartreuse, chocolate, coral, cornflowerblue,
|
||||
cornsilk, crimson, cyan, darkblue, darkcyan,
|
||||
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
||||
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
||||
darkorchid, darkred, darksalmon, darkseagreen,
|
||||
darkslateblue, darkslategray, darkslategrey,
|
||||
darkturquoise, darkviolet, deeppink, deepskyblue,
|
||||
dimgray, dimgrey, dodgerblue, firebrick,
|
||||
floralwhite, forestgreen, fuchsia, gainsboro,
|
||||
ghostwhite, gold, goldenrod, gray, grey, green,
|
||||
greenyellow, honeydew, hotpink, indianred, indigo,
|
||||
ivory, khaki, lavender, lavenderblush, lawngreen,
|
||||
lemonchiffon, lightblue, lightcoral, lightcyan,
|
||||
lightgoldenrodyellow, lightgray, lightgrey,
|
||||
lightgreen, lightpink, lightsalmon, lightseagreen,
|
||||
lightskyblue, lightslategray, lightslategrey,
|
||||
lightsteelblue, lightyellow, lime, limegreen,
|
||||
linen, magenta, maroon, mediumaquamarine,
|
||||
mediumblue, mediumorchid, mediumpurple,
|
||||
mediumseagreen, mediumslateblue, mediumspringgreen,
|
||||
mediumturquoise, mediumvioletred, midnightblue,
|
||||
mintcream, mistyrose, moccasin, navajowhite, navy,
|
||||
oldlace, olive, olivedrab, orange, orangered,
|
||||
orchid, palegoldenrod, palegreen, paleturquoise,
|
||||
palevioletred, papayawhip, peachpuff, peru, pink,
|
||||
plum, powderblue, purple, red, rosybrown,
|
||||
royalblue, rebeccapurple, saddlebrown, salmon,
|
||||
sandybrown, seagreen, seashell, sienna, silver,
|
||||
skyblue, slateblue, slategray, slategrey, snow,
|
||||
springgreen, steelblue, tan, teal, thistle, tomato,
|
||||
turquoise, violet, wheat, white, whitesmoke,
|
||||
yellow, yellowgreen
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
# family
|
||||
# ------
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser will only be able to apply a font if
|
||||
it is available on the system which it operates. Provide
|
||||
multiple font families, separated by commas, to indicate the
|
||||
preference in which to apply fonts if they aren't available on
|
||||
the system. The Chart Studio Cloud (at https://chart-
|
||||
studio.plotly.com or on-premise) generates images on a server,
|
||||
where only a select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto", "Courier New",
|
||||
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
# size
|
||||
# ----
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets this axis' title font. Note that the title's font used to
|
||||
be customized by the now deprecated `titlefont` attribute.
|
||||
|
||||
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 will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super(Font, self).__init__("font")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError(
|
||||
"""\
|
||||
The first argument to the plotly.graph_objs.layout.yaxis.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.yaxis.title.Font`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("color", None)
|
||||
_v = color if color is not None else _v
|
||||
if _v is not None:
|
||||
self["color"] = _v
|
||||
_v = arg.pop("family", None)
|
||||
_v = family if family is not None else _v
|
||||
if _v is not None:
|
||||
self["family"] = _v
|
||||
_v = arg.pop("size", None)
|
||||
_v = size if size is not None else _v
|
||||
if _v is not None:
|
||||
self["size"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
Reference in New Issue
Block a user