plotly.graph_objects.layout.xaxis.
Autorangeoptions
(arg=None, clipmax=None, clipmin=None, include=None, includesrc=None, maxallowed=None, minallowed=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
clipmax
¶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
Any
clipmin
¶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
Any
include
¶Ensure this value is included in autorange.
The ‘include’ property accepts values of any type
Any|numpy.ndarray
includesrc
¶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
maxallowed
¶Use this value exactly as autorange maximum.
The ‘maxallowed’ property accepts values of any type
Any
minallowed
¶Use this value exactly as autorange minimum.
The ‘minallowed’ property accepts values of any type
Any
plotly.graph_objects.layout.xaxis.
Minor
(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)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
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”
The ‘dtick’ property accepts values of any type
Any
gridcolor
¶Sets the color of the grid lines.
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%)’)
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
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”).
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
gridwidth
¶Sets the width (in px) of the grid lines.
An int or float in the interval [0, inf]
int|float
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”.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
showgrid
¶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)
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.
The ‘tick0’ property accepts values of any type
Any
tickcolor
¶Sets the tick color.
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%)’)
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
ticklen
¶Sets the tick length (in px).
An int or float in the interval [0, inf]
int|float
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).
[‘auto’, ‘linear’, ‘array’]
Any
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.
[‘outside’, ‘inside’, ‘’]
Any
tickvals
¶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
numpy.ndarray
tickvalssrc
¶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
tickwidth
¶Sets the tick width (in px).
An int or float in the interval [0, inf]
int|float
plotly.graph_objects.layout.xaxis.
Rangebreak
(arg=None, bounds=None, dvalue=None, enabled=None, name=None, pattern=None, templateitemname=None, values=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
bounds
¶used with pattern
.
The ‘bounds’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
The ‘bounds[0]’ property accepts values of any type
The ‘bounds[1]’ property accepts values of any type
list
dvalue
¶Sets the size of each values
item. The default is one day in
milliseconds.
An int or float in the interval [0, inf]
int|float
enabled
¶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)
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.
A string
A number that will be converted to a string
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).
[‘day of week’, ‘hour’, ‘’]
Any
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
.
A string
A number that will be converted to a string
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.
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
plotly.graph_objects.layout.xaxis.
Rangeselector
(arg=None, activecolor=None, bgcolor=None, bordercolor=None, borderwidth=None, buttons=None, buttondefaults=None, font=None, visible=None, x=None, xanchor=None, y=None, yanchor=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
activecolor
¶Sets the background color of the active range selector button.
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%)’)
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
bgcolor
¶Sets the background color of the range selector buttons.
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%)’)
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
bordercolor
¶Sets the color of the border enclosing the range selector.
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%)’)
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
borderwidth
¶Sets the width (in px) of the border enclosing the range selector.
An int or float in the interval [0, inf]
int|float
When used in a template (as layout.template.layout.xaxis.rangeselector.buttondefaults), sets the default property values to use for elements of layout.xaxis.rangeselector.buttons
The ‘buttondefaults’ property is an instance of Button that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.rangeselector.Button
A dict of string/value properties that will be passed to the Button constructor
Supported dict properties:
Sets the specifications for each buttons. By default, a range selector comes with no buttons.
The ‘buttons’ property is a tuple of instances of Button that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.xaxis.rangeselector.Button
A list or tuple of dicts of string/value properties that will be passed to the Button constructor
Supported dict properties:
- count
Sets the number of steps to take to update the range. Use with
step
to specify the update interval.- label
Sets the text label to appear on the button.
- 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 thisname
alongside your modifications (includingvisible: false
orenabled: false
to hide it). Has no effect outside of a template.- step
The unit of measurement that the
count
value will set the range by.- stepmode
Sets the range update mode. If “backward”, the range update shifts the start of range back “count” times “step” milliseconds. If “todate”, the range update shifts the start of range back to the first timestamp from “count” times “step” milliseconds back. For example, with
step
set to “year” andcount
set to 1 the range update shifts the start of the range back to January 01 of the current year. Month and year “todate” are currently available only for the built-in (Gregorian) calendar.- 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 itsname
, alongside your modifications (includingvisible: false
orenabled: false
to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true
.- visible
Determines whether or not this button is visible.
tuple[plotly.graph_objects.layout.xaxis.rangeselector.Button]
font
¶Sets the font of the range selector button text.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.rangeselector.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”.
- 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.
visible
¶Determines whether or not this range selector is visible. Note
that range selectors are only available for x axes of type
set to or auto-typed to “date”.
The ‘visible’ property must be specified as a bool (either True, or False)
x
¶Sets the x position (in normalized coordinates) of the range selector.
An int or float in the interval [-2, 3]
int|float
xanchor
¶Sets the range selector’s horizontal position anchor. This
anchor binds the x
position to the “left”, “center” or
“right” of the range selector.
[‘auto’, ‘left’, ‘center’, ‘right’]
Any
y
¶Sets the y position (in normalized coordinates) of the range selector.
An int or float in the interval [-2, 3]
int|float
yanchor
¶Sets the range selector’s vertical position anchor This anchor
binds the y
position to the “top”, “middle” or “bottom” of
the range selector.
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
Any
plotly.graph_objects.layout.xaxis.
Rangeslider
(arg=None, autorange=None, bgcolor=None, bordercolor=None, borderwidth=None, range=None, thickness=None, visible=None, yaxis=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
autorange
¶Determines whether or not the range slider range is computed in
relation to the input data. If range
is provided, then
autorange
is set to False.
The ‘autorange’ property must be specified as a bool (either True, or False)
bgcolor
¶Sets the background color of the range slider.
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%)’)
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
bordercolor
¶Sets the border color of the range slider.
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%)’)
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
borderwidth
¶Sets the border width of the range slider.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
range
¶full xaxis range. If the axis type
is “log”, then you must
take the log of your desired range. If the axis type
is
“date”, it should be date strings, like date data, though Date
objects and unix milliseconds will be accepted and converted to
strings. If the axis type
is “category”, it should be
numbers, using the scale where each category is assigned a
serial number from zero in the order it appears.
The ‘range’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type
list
thickness
¶The height of the range slider as a fraction of the total plot area height.
An int or float in the interval [0, 1]
int|float
visible
¶Determines whether or not the range slider will be visible. If
visible, perpendicular axes will be set to fixedrange
The ‘visible’ property must be specified as a bool (either True, or False)
yaxis
¶The ‘yaxis’ property is an instance of YAxis that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.rangeslider.YAxis
A dict of string/value properties that will be passed to the YAxis constructor
Supported dict properties:
- range
Sets the range of this axis for the rangeslider.
- rangemode
Determines whether or not the range of this axis in the rangeslider use the same value than in the main plot when zooming in/out. If “auto”, the autorange will be used. If “fixed”, the
range
is used. If “match”, the current range of the corresponding y-axis on the main subplot is used.
plotly.graph_objects.layout.xaxis.
Tickfont
(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
color
¶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%)’)
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
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”.
A non-empty string
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.
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’)
Any
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.
A string
A number that will be converted to a string
size
¶An int or float in the interval [1, inf]
int|float
style
¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
Any
textcase
¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
Any
variant
¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
Any
plotly.graph_objects.layout.xaxis.
Tickformatstop
(arg=None, dtickrange=None, enabled=None, name=None, templateitemname=None, value=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
dtickrange
¶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:
The ‘dtickrange[0]’ property accepts values of any type
The ‘dtickrange[1]’ property accepts values of any type
list
enabled
¶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)
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.
A string
A number that will be converted to a string
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
.
A string
A number that will be converted to a string
plotly.graph_objects.layout.xaxis.
Title
(arg=None, font=None, standoff=None, text=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
font
¶Sets this axis’ title font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.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”.
- 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.
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.
An int or float in the interval [0, inf]
int|float