GeezerVison is showing plotly.com (truncated) — plotly.graph_objects.layout package — 7.1.0 documentation
plotly.graph_objects.layout package¶
-
class
plotly.graph_objects.layout.Activeselection(arg=None, fillcolor=None, opacity=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
fillcolor¶
Sets the color filling the active selection’ interior.
- The ‘fillcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of the active selection.
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.layout.Activeshape(arg=None, fillcolor=None, opacity=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
fillcolor¶
Sets the color filling the active shape’ interior.
- The ‘fillcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of the active shape.
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.layout.Annotation(arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
align¶
Sets the horizontal alignment of the text within the box. Has
an effect only if text spans two or more lines (i.e. text
contains one or more <br> HTML tags) or if an explicit width is
set to override the text width.
- The ‘align’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
arrowcolor¶
Sets the color of the annotation arrow.
- The ‘arrowcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
arrowhead¶
Sets the end annotation arrow head style.
- The ‘arrowhead’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
arrowside¶
Sets the annotation arrow head position.
The ‘arrowside’ property is a flaglist and may be specified
as a string containing:
- Returns
-
- Return type
Any
-
property
arrowsize¶
Sets the size of the end annotation arrow head, relative to
arrowwidth. A value of 1 (default) gives a head about 3x as
wide as the line.
- The ‘arrowsize’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
arrowwidth¶
Sets the width (in px) of annotation arrow line.
- The ‘arrowwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
ax¶
Sets the x component of the arrow tail about the arrow head. If
axref is pixel, a positive (negative) component corresponds
to an arrow pointing from right to left (left to right). If
axref is not pixel and is exactly the same as xref, this
is an absolute value on that axis, like x, specified in the
same coordinates as xref.
The ‘ax’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
axref¶
Indicates in what coordinates the tail of the annotation
(ax,ay) is specified. If set to a x axis id (e.g. “x” or “x2”),
the x position refers to a x coordinate. If set to “paper”,
the x position refers to the distance from the left of the
plotting area in normalized coordinates where 0 (1) corresponds
to the left (right). If set to a x axis ID followed by “domain”
(separated by a space), the position behaves like for “paper”,
but refers to the distance in fractions of the domain length
from the left of the domain of that axis: e.g., x2 domain
refers to the domain of the second x axis and a x position of
0.5 refers to the point between the left and the right of the
domain of the second x axis. In order for absolute positioning
of the arrow to work, “axref” must be exactly the same as
“xref”, otherwise “axref” will revert to “pixel” (explained
next). For relative positioning, “axref” can be set to “pixel”,
in which case the “ax” value is specified in pixels relative to
“x”. Absolute positioning is useful for trendline annotations
which should continue to indicate the correct trend when
zoomed. Relative positioning is useful for specifying the text
offset for an annotated point.
- The ‘axref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘pixel’]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
ay¶
Sets the y component of the arrow tail about the arrow head. If
ayref is pixel, a positive (negative) component corresponds
to an arrow pointing from bottom to top (top to bottom). If
ayref is not pixel and is exactly the same as yref, this
is an absolute value on that axis, like y, specified in the
same coordinates as yref.
The ‘ay’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
ayref¶
Indicates in what coordinates the tail of the annotation
(ax,ay) is specified. If set to a y axis id (e.g. “y” or “y2”),
the y position refers to a y coordinate. If set to “paper”,
the y position refers to the distance from the bottom of the
plotting area in normalized coordinates where 0 (1) corresponds
to the bottom (top). If set to a y axis ID followed by “domain”
(separated by a space), the position behaves like for “paper”,
but refers to the distance in fractions of the domain length
from the bottom of the domain of that axis: e.g., y2 domain
refers to the domain of the second y axis and a y position of
0.5 refers to the point between the bottom and the top of the
domain of the second y axis. In order for absolute positioning
of the arrow to work, “ayref” must be exactly the same as
“yref”, otherwise “ayref” will revert to “pixel” (explained
next). For relative positioning, “ayref” can be set to “pixel”,
in which case the “ay” value is specified in pixels relative to
“y”. Absolute positioning is useful for trendline annotations
which should continue to indicate the correct trend when
zoomed. Relative positioning is useful for specifying the text
offset for an annotated point.
- The ‘ayref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘pixel’]
- A string that matches one of the following regular expressions:
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
bgcolor¶
Sets the background color of the annotation.
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bordercolor¶
Sets the color of the border enclosing the annotation text.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
borderpad¶
Sets the padding (in px) between the text and the enclosing
border.
- The ‘borderpad’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
borderwidth¶
Sets the width (in px) of the border enclosing the annotation
text.
- The ‘borderwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
captureevents¶
Determines whether the annotation text box captures mouse move
and click events, or allows those events to pass through to
data points in the plot that may be behind the annotation. By
default captureevents is False unless hovertext is
provided. If you use the event plotly_clickannotation without
hovertext you must explicitly enable captureevents.
- The ‘captureevents’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
clicktoshow¶
Makes this annotation respond to clicks on the plot. If you
click a data point that exactly matches the x and y values
of this annotation, and it is hidden (visible: false), it will
appear. In “onoff” mode, you must click the same point again to
make it disappear, so if you click multiple points, you can
show multiple annotations. In “onout” mode, a click anywhere
else in the plot (on another data point or not) will hide this
annotation. If you need to show/hide this annotation in
response to different x or y values, you can set xclick
and/or yclick. This is useful for example to label the side
of a bar. To label markers though, standoff is preferred over
xclick and yclick.
- The ‘clicktoshow’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, ‘onoff’, ‘onout’]
- Returns
-
- Return type
Any
-
property
font¶
Sets the annotation text font.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.annotation.Font
-
property
height¶
Sets an explicit height for the text box. null (default) lets
the text set the box height. Taller text will be clipped.
- The ‘height’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
hoverlabel¶
The ‘hoverlabel’ property is an instance of Hoverlabel
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.annotation.Hoverlabel
-
property
hovertext¶
Sets text to appear when hovering over this annotation. If
omitted or blank, no hover label will appear.
- The ‘hovertext’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of the annotation (text + arrow).
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
showarrow¶
Determines whether or not the annotation is drawn with an
arrow. If True, text is placed near the arrow’s tail. If
False, text lines up with the x and y provided.
- The ‘showarrow’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
standoff¶
Sets a distance, in pixels, to move the end arrowhead away from
the position it is pointing at, for example to point at the
edge of a marker independent of zoom. Note that this shortens
the arrow from the ax / ay vector, in contrast to xshift
/ yshift which moves everything by this amount.
- The ‘standoff’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
startarrowhead¶
Sets the start annotation arrow head style.
- The ‘startarrowhead’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
startarrowsize¶
Sets the size of the start annotation arrow head, relative to
arrowwidth. A value of 1 (default) gives a head about 3x as
wide as the line.
- The ‘startarrowsize’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
startstandoff¶
Sets a distance, in pixels, to move the start arrowhead away
from the position it is pointing at, for example to point at
the edge of a marker independent of zoom. Note that this
shortens the arrow from the ax / ay vector, in contrast to
xshift / yshift which moves everything by this amount.
- The ‘startstandoff’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘templateitemname’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
text¶
Sets the text associated with this annotation. Plotly uses a
subset of HTML tags to do things like newline (<br>), bold
(<b></b>), italics (<i></i>), hyperlinks (<a
href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>,
and <span> are also supported.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
textangle¶
Sets the angle at which the text is drawn with respect to the
horizontal.
The ‘textangle’ property is a angle (in degrees) that may be
specified as a number between -180 and 180.
Numeric values outside this range are converted to the equivalent value
(e.g. 270 is converted to -90).
- Returns
-
- Return type
int|float
-
property
valign¶
Sets the vertical alignment of the text within the box. Has
an effect only if an explicit height is set to override the
text height.
- The ‘valign’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
visible¶
Determines whether or not this annotation is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
width¶
Sets an explicit width for the text box. null (default) lets
the text set the box width. Wider text will be clipped. There
is no automatic wrapping; use <br> to start a new line.
- The ‘width’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
x¶
Sets the annotation’s x position. 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 ‘x’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
xanchor¶
Sets the text box’s horizontal position anchor This anchor
binds the x position to the “left”, “center” or “right” of
the annotation. For example, if x is set to 1, xref to
“paper” and xanchor to “right” then the right-most portion of
the annotation lines up with the right-most edge of the
plotting area. If “auto”, the anchor is equivalent to “center”
for data-referenced annotations or if there is an arrow,
whereas for paper-referenced with no arrow, the anchor picked
corresponds to the closest side.
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
xclick¶
Toggle this annotation when clicking a data point whose x
value is xclick rather than the annotation’s x value.
The ‘xclick’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
xref¶
Sets the annotation’s x coordinate axis. If set to a x axis id
(e.g. “x” or “x2”), the x position refers to a x coordinate.
If set to “paper”, the x position refers to the distance from
the left of the plotting area in normalized coordinates where 0
(1) corresponds to the left (right). If set to a x axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the left of the domain of
that axis: e.g., x2 domain refers to the domain of the second
x axis and a x position of 0.5 refers to the point between the
left and the right of the domain of the second x axis.
- The ‘xref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘paper’]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
xshift¶
Shifts the position of the whole annotation and arrow to the
right (positive) or left (negative) by this many pixels.
- The ‘xshift’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
y¶
Sets the annotation’s y position. 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 ‘y’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
yanchor¶
Sets the text box’s vertical position anchor This anchor binds
the y position to the “top”, “middle” or “bottom” of the
annotation. For example, if y is set to 1, yref to “paper”
and yanchor to “top” then the top-most portion of the
annotation lines up with the top-most edge of the plotting
area. If “auto”, the anchor is equivalent to “middle” for data-
referenced annotations or if there is an arrow, whereas for
paper-referenced with no arrow, the anchor picked corresponds
to the closest side.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
yclick¶
Toggle this annotation when clicking a data point whose y
value is yclick rather than the annotation’s y value.
The ‘yclick’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
yref¶
Sets the annotation’s y coordinate axis. If set to a y axis id
(e.g. “y” or “y2”), the y position refers to a y coordinate.
If set to “paper”, the y position refers to the distance from
the bottom of the plotting area in normalized coordinates where
0 (1) corresponds to the bottom (top). If set to a y axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the bottom of the domain of
that axis: e.g., y2 domain refers to the domain of the second
y axis and a y position of 0.5 refers to the point between the
bottom and the top of the domain of the second y axis.
- The ‘yref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘paper’]
- A string that matches one of the following regular expressions:
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
yshift¶
Shifts the position of the whole annotation and arrow up
(positive) or down (negative) by this many pixels.
- The ‘yshift’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.layout.Coloraxis(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, colorbar=None, colorscale=None, reversescale=None, showscale=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
autocolorscale¶
Determines whether the colorscale is a default palette
(autocolorscale: true) or the palette determined by
colorscale. In case colorscale is unspecified or
autocolorscale is true, the default palette will be chosen
according to whether numbers in the color array are all
positive, all negative or mixed.
- The ‘autocolorscale’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
cauto¶
Determines whether or not the color domain is computed with
respect to the input data (here corresponding trace color
array(s)) or the bounds set in cmin and cmax Defaults to
false when cmin and cmax are set by the user.
- The ‘cauto’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
cmax¶
Sets the upper bound of the color domain. Value should have the
same units as corresponding trace color array(s) and if set,
cmin must be set as well.
- The ‘cmax’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
cmid¶
Sets the mid-point of the color domain by scaling cmin and/or
cmax to be equidistant to this point. Value should have the
same units as corresponding trace color array(s). Has no effect
when cauto is false.
- The ‘cmid’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
cmin¶
Sets the lower bound of the color domain. Value should have the
same units as corresponding trace color array(s) and if set,
cmax must be set as well.
- The ‘cmin’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
colorbar¶
The ‘colorbar’ property is an instance of ColorBar
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.coloraxis.ColorBar
-
property
colorscale¶
Sets the colorscale. The colorscale must be an array containing
arrays mapping a normalized value to an rgb, rgba, hex, hsl,
hsla, hwb, or named color string. At minimum, a mapping for the
lowest (0) and highest (1) values are required. For example,
[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the
bounds of the colorscale in color space, use cmin and cmax.
Alternatively, colorscale may be a palette name string of the
following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
YlGnBu,YlOrRd.
The ‘colorscale’ property is a colorscale and may be
specified as:
A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package. A list of 2-element lists where the first element is the
normalized color level value (starting at 0 and ending at 1),
and the second item is a valid color string.
(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’,
‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’,
‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’,
‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’,
‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’,
‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’,
‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’,
‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’,
‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’,
‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’,
‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’,
‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’,
‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’,
‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
-
- Return type
str
-
property
reversescale¶
Reverses the color mapping if true. If true, cmin will
correspond to the last color in the array and cmax will
correspond to the first color.
- The ‘reversescale’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showscale¶
Determines whether or not a colorbar is displayed for this
trace.
- The ‘showscale’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.layout.Colorscale(arg=None, diverging=None, sequential=None, sequentialminus=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
diverging¶
Sets the default diverging colorscale. Note that
autocolorscale must be true for this attribute to work.
The ‘diverging’ property is a colorscale and may be
specified as:
A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package. A list of 2-element lists where the first element is the
normalized color level value (starting at 0 and ending at 1),
and the second item is a valid color string.
(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’,
‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’,
‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’,
‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’,
‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’,
‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’,
‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’,
‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’,
‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’,
‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’,
‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’,
‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’,
‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’,
‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
-
- Return type
str
-
property
sequential¶
Sets the default sequential colorscale for positive values.
Note that autocolorscale must be true for this attribute to
work.
The ‘sequential’ property is a colorscale and may be
specified as:
A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package. A list of 2-element lists where the first element is the
normalized color level value (starting at 0 and ending at 1),
and the second item is a valid color string.
(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’,
‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’,
‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’,
‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’,
‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’,
‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’,
‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’,
‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’,
‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’,
‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’,
‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’,
‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’,
‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’,
‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
-
- Return type
str
-
property
sequentialminus¶
Sets the default sequential colorscale for negative values.
Note that autocolorscale must be true for this attribute to
work.
The ‘sequentialminus’ property is a colorscale and may be
specified as:
A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package. A list of 2-element lists where the first element is the
normalized color level value (starting at 0 and ending at 1),
and the second item is a valid color string.
(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’,
‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’,
‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’,
‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’,
‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’,
‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’,
‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’,
‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’,
‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’,
‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’,
‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’,
‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’,
‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’,
‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
-
- Return type
str
-
class
plotly.graph_objects.layout.Font(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
-
property
color¶
- The ‘color’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
family¶
HTML font family - the typeface that will be applied by the web
browser. The web browser can only apply a font if it is
available on the system where it runs. Provide multiple font
families, separated by commas, to indicate the order in which
to apply fonts if they aren’t available.
- The ‘family’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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:
- Returns
-
- Return type
Any
-
property
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.
- The ‘shadow’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
size¶
- The ‘size’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
style¶
Sets whether a font should be styled with a normal or italic
face from its family.
- The ‘style’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘italic’]
- Returns
-
- Return type
Any
-
property
textcase¶
Sets capitalization of text. It can be used to make text appear
in all-uppercase or all-lowercase, or with each word
capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
- Returns
-
- Return type
Any
-
property
variant¶
Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’,
‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
- Returns
-
- Return type
Any
-
property
weight¶
Sets the weight (or boldness) of the font.
- The ‘weight’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
class
plotly.graph_objects.layout.Geo(arg=None, bgcolor=None, center=None, coastlinecolor=None, coastlinewidth=None, countrycolor=None, countrywidth=None, domain=None, fitbounds=None, framecolor=None, framewidth=None, lakecolor=None, landcolor=None, lataxis=None, lonaxis=None, oceancolor=None, projection=None, resolution=None, rivercolor=None, riverwidth=None, scope=None, showcoastlines=None, showcountries=None, showframe=None, showlakes=None, showland=None, showocean=None, showrivers=None, showsubunits=None, subunitcolor=None, subunitwidth=None, uirevision=None, visible=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
bgcolor¶
Set the background color of the map
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
center¶
The ‘center’ property is an instance of Center
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.geo.Center
-
property
coastlinecolor¶
Sets the coastline color.
- The ‘coastlinecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
coastlinewidth¶
Sets the coastline stroke width (in px).
- The ‘coastlinewidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
countrycolor¶
Sets line color of the country boundaries.
- The ‘countrycolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
countrywidth¶
Sets line width (in px) of the country boundaries.
- The ‘countrywidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.geo.Domain
-
property
fitbounds¶
Determines if this subplot’s view settings are auto-computed to
fit trace data. On scoped maps, setting fitbounds leads to
center.lon and center.lat getting auto-filled. On maps with
a non-clipped projection, setting fitbounds leads to
center.lon, center.lat, and projection.rotation.lon
getting auto-filled. On maps with a clipped projection, setting
fitbounds leads to center.lon, center.lat,
projection.rotation.lon, projection.rotation.lat,
lonaxis.range and lataxis.range getting auto-filled. If
“locations” (default), only the trace’s visible locations are
considered in the fitbounds computations. If “geojson”, the
entire trace input geojson (if provided) is considered in the
fitbounds computations. If False, the view settings are used
as-is; set this to opt out of auto-fitting.
- The ‘fitbounds’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, ‘locations’, ‘geojson’]
- Returns
-
- Return type
Any
-
property
framecolor¶
Sets the color the frame.
- The ‘framecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
framewidth¶
Sets the stroke width (in px) of the frame.
- The ‘framewidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
lakecolor¶
Sets the color of the lakes.
- The ‘lakecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
landcolor¶
Sets the land mass color.
- The ‘landcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
lataxis¶
The ‘lataxis’ property is an instance of Lataxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.geo.Lataxis
-
property
lonaxis¶
The ‘lonaxis’ property is an instance of Lonaxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.geo.Lonaxis
-
property
oceancolor¶
Sets the ocean color
- The ‘oceancolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
projection¶
The ‘projection’ property is an instance of Projection
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.geo.Projection
-
property
resolution¶
Sets the resolution of the base layers. The values have units
of km/mm e.g. 110 corresponds to a scale ratio of
1:110,000,000.
- The ‘resolution’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[110, 50]
- Returns
-
- Return type
Any
-
property
rivercolor¶
Sets color of the rivers.
- The ‘rivercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
riverwidth¶
Sets the stroke width (in px) of the rivers.
- The ‘riverwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
scope¶
Set the scope of the map.
- The ‘scope’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘africa’, ‘antarctica’, ‘asia’, ‘europe’, ‘north
america’, ‘oceania’, ‘south america’, ‘usa’, ‘world’]
- Returns
-
- Return type
Any
-
property
showcoastlines¶
Sets whether or not the coastlines are drawn.
- The ‘showcoastlines’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showcountries¶
Sets whether or not country boundaries are drawn.
- The ‘showcountries’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showframe¶
Sets whether or not a frame is drawn around the map.
- The ‘showframe’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showlakes¶
Sets whether or not lakes are drawn.
- The ‘showlakes’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showland¶
Sets whether or not land masses are filled in color.
- The ‘showland’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showocean¶
Sets whether or not oceans are filled in color.
- The ‘showocean’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showrivers¶
Sets whether or not rivers are drawn.
- The ‘showrivers’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showsubunits¶
Sets whether or not boundaries of subunits within countries
(e.g. states, provinces) are drawn.
- The ‘showsubunits’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
subunitcolor¶
Sets the color of the subunits boundaries.
- The ‘subunitcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
subunitwidth¶
Sets the stroke width (in px) of the subunits boundaries.
- The ‘subunitwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
uirevision¶
Controls persistence of user-driven changes in the view
(projection and center). Defaults to layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
visible¶
Sets the default visibility of the base layers.
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.layout.Grid(arg=None, columns=None, domain=None, pattern=None, roworder=None, rows=None, subplots=None, xaxes=None, xgap=None, xside=None, yaxes=None, ygap=None, yside=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
columns¶
The number of columns in the grid. If you provide a 2D
subplots array, the length of its longest row is used as the
default. If you give an xaxes array, its length is used as
the default. But it’s also possible to have a different length,
if you want to leave a row at the end for non-cartesian
subplots.
- The ‘columns’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.grid.Domain
-
property
pattern¶
If no subplots, xaxes, or yaxes are given but we do have
rows and columns, we can generate defaults using
consecutive axis IDs, in two ways: “coupled” gives one x axis
per column and one y axis per row. “independent” uses a new xy
pair for each cell, left-to-right across each row then
iterating rows according to roworder.
- The ‘pattern’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘independent’, ‘coupled’]
- Returns
-
- Return type
Any
-
property
roworder¶
Is the first row the top or the bottom? Note that columns are
always enumerated from left to right.
- The ‘roworder’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top to bottom’, ‘bottom to top’]
- Returns
-
- Return type
Any
-
property
rows¶
The number of rows in the grid. If you provide a 2D subplots
array or a yaxes array, its length is used as the default.
But it’s also possible to have a different length, if you want
to leave a row at the end for non-cartesian subplots.
- The ‘rows’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
subplots¶
Used for freeform grids, where some axes may be shared across
subplots but others are not. Each entry should be a cartesian
subplot id, like “xy” or “x3y2”, or “” to leave that cell
empty. You may reuse x axes within the same column, and y axes
within the same row. Non-cartesian subplots and traces that
support domain can place themselves in this grid separately
using the gridcell attribute.
The ‘subplots’ property is an info array that may be specified as:
* a 2D list where:
The ‘subplots[i][j]’ property is an enumeration that may be specified as:
- One of the following enumeration values:
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$’]
- Returns
-
- Return type
list
-
property
xaxes¶
Used with yaxes when the x and y axes are shared across
columns and rows. Each entry should be an x axis id like “x”,
“x2”, etc., or “” to not put an x axis in that column. Entries
other than “” must be unique. Ignored if subplots is present.
If missing but yaxes is present, will generate consecutive
IDs.
The ‘xaxes’ property is an info array that may be specified as:
* a list of elements where:
The ‘xaxes[i]’ property is an enumeration that may be specified as:
- One of the following enumeration values:
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
list
-
property
xgap¶
Horizontal space between grid cells, expressed as a fraction of
the total width available to one cell. Defaults to 0.1 for
coupled-axes grids and 0.2 for independent grids.
- The ‘xgap’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
xside¶
Sets where the x axis labels and titles go. “bottom” means the
very bottom of the grid. “bottom plot” is the lowest plot that
each x axis is used in. “top” and “top plot” are similar.
- The ‘xside’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘bottom’, ‘bottom plot’, ‘top plot’, ‘top’]
- Returns
-
- Return type
Any
-
property
yaxes¶
Used with yaxes when the x and y axes are shared across
columns and rows. Each entry should be an y axis id like “y”,
“y2”, etc., or “” to not put a y axis in that row. Entries
other than “” must be unique. Ignored if subplots is present.
If missing but xaxes is present, will generate consecutive
IDs.
The ‘yaxes’ property is an info array that may be specified as:
* a list of elements where:
The ‘yaxes[i]’ property is an enumeration that may be specified as:
- One of the following enumeration values:
- A string that matches one of the following regular expressions:
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
list
-
property
ygap¶
Vertical space between grid cells, expressed as a fraction of
the total height available to one cell. Defaults to 0.1 for
coupled-axes grids and 0.3 for independent grids.
- The ‘ygap’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
yside¶
Sets where the y axis labels and titles go. “left” means the
very left edge of the grid. left plot is the leftmost plot
that each y axis is used in. “right” and right plot are
similar.
- The ‘yside’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘left plot’, ‘right plot’, ‘right’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, grouptitlefont=None, namelength=None, showarrow=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
align¶
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
- The ‘align’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘right’, ‘auto’]
- Returns
-
- Return type
Any
-
property
bgcolor¶
Sets the background color of all hover labels on graph
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bordercolor¶
Sets the border color of all hover labels on graph.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
font¶
Sets the default hover label font used by all traces on the
graph.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.hoverlabel.Font
-
property
grouptitlefont¶
Sets the font for group titles in hover (unified modes).
Defaults to hoverlabel.font.
The ‘grouptitlefont’ property is an instance of Grouptitlefont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.hoverlabel.Grouptitlefont
-
property
namelength¶
Sets the default length (in number of characters) of the trace
name in the hover labels for all traces. -1 shows the whole
name regardless of length. 0-3 shows the first 0-3 characters,
and an integer >3 will show the whole name if it is less than
that many characters, but if it is longer, will truncate to
namelength - 3 characters and add an ellipsis.
- The ‘namelength’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
showarrow¶
Sets whether or not to show the hover label arrow/triangle
pointing to the data point.
- The ‘showarrow’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.layout.Image(arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
layer¶
Specifies whether images are drawn below or above traces. When
xref and yref are both set to paper, image is drawn below
the entire plot area.
- The ‘layer’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘below’, ‘above’]
- Returns
-
- Return type
Any
-
property
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.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of the image.
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
sizex¶
Sets the image container size horizontally. The image will be
sized based on the position value. When xref is set to
paper, units are sized relative to the plot width. When
xref ends with ` domain`, units are sized relative to the
axis width.
- The ‘sizex’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
sizey¶
Sets the image container size vertically. The image will be
sized based on the position value. When yref is set to
paper, units are sized relative to the plot height. When
yref ends with ` domain`, units are sized relative to the
axis height.
- The ‘sizey’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
sizing¶
Specifies which dimension of the image to constrain.
- The ‘sizing’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘fill’, ‘contain’, ‘stretch’]
- Returns
-
- Return type
Any
-
property
source¶
Specifies the URL of the image to be used. The URL must be
accessible from the domain where the plot code is run, and can
be either relative or absolute.
- The ‘source’ property is an image URI that may be specified as:
-
- Returns
-
- Return type
str
-
property
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.
- The ‘templateitemname’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
visible¶
Determines whether or not this image is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
x¶
Sets the image’s x position. When xref is set to paper,
units are sized relative to the plot height. See xref for
more info
The ‘x’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
xanchor¶
Sets the anchor for the x position
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
xref¶
Sets the images’s x coordinate axis. If set to a x axis id
(e.g. “x” or “x2”), the x position refers to a x coordinate.
If set to “paper”, the x position refers to the distance from
the left of the plotting area in normalized coordinates where 0
(1) corresponds to the left (right). If set to a x axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the left of the domain of
that axis: e.g., x2 domain refers to the domain of the second
x axis and a x position of 0.5 refers to the point between the
left and the right of the domain of the second x axis.
- The ‘xref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘paper’]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
y¶
Sets the image’s y position. When yref is set to paper,
units are sized relative to the plot height. See yref for
more info
The ‘y’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
yanchor¶
Sets the anchor for the y position.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
yref¶
Sets the images’s y coordinate axis. If set to a y axis id
(e.g. “y” or “y2”), the y position refers to a y coordinate.
If set to “paper”, the y position refers to the distance from
the bottom of the plotting area in normalized coordinates where
0 (1) corresponds to the bottom (top). If set to a y axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the bottom of the domain of
that axis: e.g., y2 domain refers to the domain of the second
y axis and a y position of 0.5 refers to the point between the
bottom and the top of the domain of the second y axis.
- The ‘yref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘paper’]
- A string that matches one of the following regular expressions:
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Legend(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, entrywidth=None, entrywidthmode=None, font=None, groupclick=None, groupdoubleclick=None, grouptitlefont=None, indentation=None, itemclick=None, itemdoubleclick=None, itemsizing=None, itemwidth=None, maxheight=None, orientation=None, title=None, titleclick=None, titledoubleclick=None, tracegroupgap=None, traceorder=None, uirevision=None, valign=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
bgcolor¶
Sets the legend background color. Defaults to
layout.paper_bgcolor.
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bordercolor¶
Sets the color of the border enclosing the legend.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
borderwidth¶
Sets the width (in px) of the border enclosing the legend.
- The ‘borderwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
entrywidth¶
Sets the width (in px or fraction) of the legend. Use 0 to size
the entry based on the text width, when entrywidthmode is set
to “pixels”.
- The ‘entrywidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
entrywidthmode¶
Determines what entrywidth means.
- The ‘entrywidthmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘fraction’, ‘pixels’]
- Returns
-
- Return type
Any
-
property
font¶
Sets the font used to text the legend items.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.legend.Font
-
property
groupclick¶
Determines the behavior on legend group item click.
“toggleitem” toggles the visibility of the individual item
clicked on the graph. “togglegroup” toggles the visibility of
all items in the same legendgroup as the item clicked on the
graph.
- The ‘groupclick’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘toggleitem’, ‘togglegroup’]
- Returns
-
- Return type
Any
-
property
groupdoubleclick¶
Determines the behavior on legend group item double-click.
“toggleitem” toggles the visibility of the individual item
clicked on the graph. “togglegroup” toggles the visibility of
all items in the same legendgroup as the item clicked on the
graph. Defaults to the value of groupclick.
- The ‘groupdoubleclick’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘toggleitem’, ‘togglegroup’]
- Returns
-
- Return type
Any
-
property
grouptitlefont¶
Sets the font for group titles in legend. Defaults to
legend.font with its size increased about 10%.
The ‘grouptitlefont’ property is an instance of Grouptitlefont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.legend.Grouptitlefont
-
property
indentation¶
Sets the indentation (in px) of the legend entries.
- The ‘indentation’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
itemclick¶
Determines the behavior on legend item click. “toggle” toggles
the visibility of the item clicked on the graph. “toggleothers”
makes the clicked item the sole visible item on the graph.
False disables legend item click interactions.
- The ‘itemclick’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘toggle’, ‘toggleothers’, False]
- Returns
-
- Return type
Any
-
property
itemdoubleclick¶
Determines the behavior on legend item double-click. “toggle”
toggles the visibility of the item clicked on the graph.
“toggleothers” makes the clicked item the sole visible item on
the graph. False disables legend item double-click
interactions.
- The ‘itemdoubleclick’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘toggle’, ‘toggleothers’, False]
- Returns
-
- Return type
Any
-
property
itemsizing¶
Determines if the legend items symbols scale with their
corresponding “trace” attributes or remain “constant”
independent of the symbol size on the graph.
- The ‘itemsizing’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘trace’, ‘constant’]
- Returns
-
- Return type
Any
-
property
itemwidth¶
Sets the width (in px) of the legend item symbols (the part
other than the title.text).
- The ‘itemwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
maxheight¶
Sets the max height (in px) of the legend, or max height ratio
(reference height * ratio) if less than or equal to 1. Default
value is: 0.5 for horizontal legends; 1 for vertical legends.
The minimum allowed height is 30px. For a ratio of 0.5, the
legend will take up to 50% of the reference height before
displaying a scrollbar. The reference height is the full layout
height with the following exception: vertically oriented
legends with a yref of `”paper”, located to the side of the
plot. In this case, the reference height is the plot height.
- The ‘maxheight’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
orientation¶
Sets the orientation of the legend.
- The ‘orientation’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘v’, ‘h’]
- Returns
-
- Return type
Any
-
property
title¶
The ‘title’ property is an instance of Title
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.legend.Title
-
property
titleclick¶
Determines the behavior on legend title click. “toggle” toggles
the visibility of all items in the legend. “toggleothers”
toggles the visibility of all other legends. False disables
legend title click interactions. Defaults to “toggle” when
there are multiple legends, False otherwise. Not supported for
legends containing pie and pie-like traces.
- The ‘titleclick’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘toggle’, ‘toggleothers’, False]
- Returns
-
- Return type
Any
-
property
titledoubleclick¶
Determines the behavior on legend title double-click. “toggle”
toggles the visibility of all items in the legend.
“toggleothers” toggles the visibility of all other legends.
False disables legend title double-click interactions. Defaults
to “toggleothers” when there are multiple legends, False
otherwise. Not supported for legends containing pie and pie-
like traces.
- The ‘titledoubleclick’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘toggle’, ‘toggleothers’, False]
- Returns
-
- Return type
Any
-
property
tracegroupgap¶
Sets the amount of vertical space (in px) between legend
groups.
- The ‘tracegroupgap’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
traceorder¶
Determines the order at which the legend items are displayed.
If “normal”, the items are displayed top-to-bottom in the same
order as the input data. If “reversed”, the items are displayed
in the opposite order as “normal”. If “grouped”, the items are
displayed in groups (when a trace legendgroup is provided).
if “grouped+reversed”, the items are displayed in the opposite
order as “grouped”.
The ‘traceorder’ property is a flaglist and may be specified
as a string containing:
- Returns
-
- Return type
Any
-
property
uirevision¶
Controls persistence of legend-driven changes in trace and pie
label visibility. Defaults to layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
valign¶
Sets the vertical alignment of the symbols with respect to
their associated text.
- The ‘valign’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
visible¶
Determines whether or not this legend is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
x¶
Sets the x position with respect to xref (in normalized
coordinates) of the legend. When xref is “paper”, defaults to
1.02 for vertical legends and defaults to 0 for horizontal
legends. When xref is “container”, defaults to 1 for vertical
legends and defaults to 0 for horizontal legends. Must be
between 0 and 1 if xref is “container”. and between “-2” and
3 if xref is “paper”.
- The ‘x’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
xanchor¶
Sets the legend’s horizontal position anchor. This anchor binds
the x position to the “left”, “center” or “right” of the
legend. Value “auto” anchors legends to the right for x
values greater than or equal to 2/3, anchors legends to the
left for x values less than or equal to 1/3 and anchors
legends with respect to their center otherwise.
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
xref¶
Sets the container x refers to. “container” spans the entire
width of the plot. “paper” refers to the width of the
plotting area only.
- The ‘xref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘container’, ‘paper’]
- Returns
-
- Return type
Any
-
property
y¶
Sets the y position with respect to yref (in normalized
coordinates) of the legend. When yref is “paper”, defaults to
1 for vertical legends, defaults to “-0.1” for horizontal
legends on graphs w/o range sliders and defaults to 1.1 for
horizontal legends on graph with one or multiple range sliders.
When yref is “container”, defaults to 1. Must be between 0
and 1 if yref is “container” and between “-2” and 3 if yref
is “paper”.
- The ‘y’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
yanchor¶
Sets the legend’s vertical position anchor. This anchor binds
the y position to the “top”, “middle” or “bottom” of the
legend. Value “auto” anchors legends at their bottom for y
values less than or equal to 1/3, anchors legends to at their
top for y values greater than or equal to 2/3 and anchors
legends with respect to their middle otherwise.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
yref¶
Sets the container y refers to. “container” spans the entire
height of the plot. “paper” refers to the height of the
plotting area only.
- The ‘yref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘container’, ‘paper’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Map(arg=None, bearing=None, bounds=None, center=None, domain=None, fitbounds=None, layers=None, layerdefaults=None, pitch=None, style=None, uirevision=None, zoom=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
bearing¶
Sets the bearing angle of the map in degrees counter-clockwise
from North (map.bearing).
- The ‘bearing’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
bounds¶
The ‘bounds’ property is an instance of Bounds
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.map.Bounds
-
property
center¶
The ‘center’ property is an instance of Center
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.map.Center
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.map.Domain
-
property
fitbounds¶
Determines if this subplot’s view settings are auto-computed to
fit trace data. If “locations” (default), the view is auto-fit
to the lon/lat coordinates of the visible trace data. If False,
the view settings are used as-is; set this to opt out of auto-
fitting. If fitbounds is enabled but a user provides center
or zoom, auto-fit will be skipped.
- The ‘fitbounds’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, ‘locations’]
- Returns
-
- Return type
Any
-
property
layerdefaults¶
When used in a template (as
layout.template.layout.map.layerdefaults), sets the default
property values to use for elements of layout.map.layers
The ‘layerdefaults’ property is an instance of Layer
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.map.Layer
-
property
layers¶
The ‘layers’ property is a tuple of instances of
Layer that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.layout.map.Layer]
-
property
pitch¶
Sets the pitch angle of the map (in degrees, where 0 means
perpendicular to the surface of the map) (map.pitch).
- The ‘pitch’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
style¶
Defines the map layers that are rendered by default below the
trace layers defined in data, which are themselves by default
rendered below the layers defined in layout.map.layers.
These layers can be defined either explicitly as a Map Style
object which can contain multiple layer definitions that load
data from any public or private Tile Map Service (TMS or XYZ)
or Web Map Service (WMS) or implicitly by using one of the
built-in style objects which use WMSes or by using a custom
style URL Map Style objects are of the form described in the
MapLibre GL JS documentation available at
https://maplibre.org/maplibre-style-spec/ The built-in
plotly.js styles objects are: basic, carto-darkmatter, carto-
darkmatter-nolabels, carto-positron, carto-positron-nolabels,
carto-voyager, carto-voyager-nolabels, dark, light, open-
street-map, outdoors, satellite, satellite-streets, streets,
white-bg.
The ‘style’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
uirevision¶
Controls persistence of user-driven changes in the view:
center, zoom, bearing, pitch. Defaults to
layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
zoom¶
Sets the zoom level of the map (map.zoom).
- The ‘zoom’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.layout.Margin(arg=None, autoexpand=None, b=None, l=None, pad=None, r=None, t=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
autoexpand¶
Turns on/off margin expansion computations. Legends, colorbars,
updatemenus, sliders, axis rangeselector and rangeslider are
allowed to push the margins by defaults.
- The ‘autoexpand’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
b¶
Sets the bottom margin (in px).
- The ‘b’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
l¶
Sets the left margin (in px).
- The ‘l’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
pad¶
Sets the amount of padding (in px) between the plotting area
and the axis lines
- The ‘pad’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
r¶
Sets the right margin (in px).
- The ‘r’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
t¶
Sets the top margin (in px).
- The ‘t’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.layout.Modebar(arg=None, activecolor=None, add=None, bgcolor=None, color=None, orientation=None, remove=None, uirevision=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
activecolor¶
Sets the color of the active or hovered on icons in the
modebar.
- The ‘activecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
add¶
Determines which predefined modebar buttons to add. Please note
that these buttons will only be shown if they are compatible
with all trace types used in a graph. Similar to
config.modeBarButtonsToAdd option. This may include
“v1hovermode”, “hoverclosest”, “hovercompare”, “togglehover”,
“togglespikelines”, “drawline”, “drawopenpath”,
“drawclosedpath”, “drawcircle”, “drawrect”, “eraseshape”,
“downloadJson”.
- The ‘add’ property is a string and must be specified as:
A string A number that will be converted to a string A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
bgcolor¶
Sets the background color of the modebar.
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
color¶
Sets the color of the icons in the modebar.
- The ‘color’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
orientation¶
Sets the orientation of the modebar.
- The ‘orientation’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘v’, ‘h’]
- Returns
-
- Return type
Any
-
property
remove¶
Determines which predefined modebar buttons to remove. Similar
to config.modeBarButtonsToRemove option. This may include
“autoScale2d”, “autoscale”, “hoverCompareCartesian”,
“hovercompare”, “lasso”, “lasso2d”, “orbitRotation”,
“orbitrotation”, “pan”, “pan2d”, “pan3d”, “reset”,
“resetCameraDefault3d”, “resetCameraLastSave3d”, “resetGeo”,
“resetSankeyGroup”, “resetScale2d”, “resetViewMap”,
“resetViews”, “resetcameradefault”, “resetcameralastsave”,
“resetsankeygroup”, “resetscale”, “resetview”, “resetviews”,
“select”, “select2d”, “sendChartToCloud”, “sendcharttocloud”,
“tableRotation”, “tablerotation”, “toImage”, “toggleHover”,
“toggleSpikelines”, “togglehover”, “togglespikelines”,
“toimage”, “zoom”, “zoom2d”, “zoom3d”, “zoomIn2d”, “zoomInGeo”,
“zoomInMap”, “zoomOut2d”, “zoomOutGeo”, “zoomOutMap”, “zoomin”,
“zoomout”.
- The ‘remove’ property is a string and must be specified as:
A string A number that will be converted to a string A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
uirevision¶
Controls persistence of user-driven changes related to the
modebar, including hovermode, dragmode, and showspikes at
both the root level and inside subplots. Defaults to
layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Newselection(arg=None, line=None, mode=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.newselection.Line
-
property
mode¶
Describes how a new selection is created. If immediate, a new
selection is created after first mouse up. If gradual, a new
selection is not created after first mouse. By adding to and
subtracting from the initial selection, this option allows
declaring extra outlines of the selection.
- The ‘mode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘immediate’, ‘gradual’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Newshape(arg=None, drawdirection=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, showlegend=None, visible=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
drawdirection¶
When dragmode is set to “drawrect”, “drawline” or
“drawcircle” this limits the drag to be horizontal, vertical or
diagonal. Using “diagonal” there is no limit e.g. in drawing
lines in any direction. “ortho” limits the draw to be either
horizontal or vertical. “horizontal” allows horizontal extend.
“vertical” allows vertical extend.
- The ‘drawdirection’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘ortho’, ‘horizontal’, ‘vertical’, ‘diagonal’]
- Returns
-
- Return type
Any
-
property
fillcolor¶
Sets the color filling new shapes’ interior. Please note that
if using a fillcolor with alpha greater than half, drag inside
the active shape starts moving the shape underneath, otherwise
a new shape could be started over.
- The ‘fillcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
fillrule¶
Determines the path’s interior. For more info please visit
https://developer.mozilla.org/en-
US/docs/Web/SVG/Attribute/fill-rule
- The ‘fillrule’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘evenodd’, ‘nonzero’]
- Returns
-
- Return type
Any
-
property
label¶
The ‘label’ property is an instance of Label
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.newshape.Label
-
property
layer¶
Specifies whether new shapes are drawn below gridlines
(“below”), between gridlines and traces (“between”) or above
traces (“above”).
- The ‘layer’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘below’, ‘above’, ‘between’]
- Returns
-
- Return type
Any
-
property
legend¶
Sets the reference to a legend to show new shape in. References
to these legends are “legend”, “legend2”, “legend3”, etc.
Settings for these legends are set in the layout, under
layout.legend, layout.legend2, etc.
The ‘legend’ property is an identifier of a particular
subplot, of type ‘legend’, that may be specified as:
the string ‘legend’ optionally followed by an integer >= 1
(e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)
- Returns
-
- Return type
str
-
property
legendgroup¶
Sets the legend group for new shape. Traces and shapes part of
the same legend group hide/show at the same time when toggling
legend items.
- The ‘legendgroup’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
legendgrouptitle¶
The ‘legendgrouptitle’ property is an instance of Legendgrouptitle
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.newshape.Legendgrouptitle
-
property
legendrank¶
Sets the legend rank for new shape. Items and groups with
smaller ranks are presented on top/left side while with
“reversed” legend.traceorder they are on bottom/right side.
The default legendrank is 1000, so that you can use ranks less
than 1000 to place certain items before all unranked items, and
ranks greater than 1000 to go after all unranked items.
- The ‘legendrank’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
legendwidth¶
Sets the width (in px or fraction) of the legend for new shape.
- The ‘legendwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.newshape.Line
-
property
name¶
Sets new shape name. The name appears as the legend item.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of new shapes.
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
showlegend¶
Determines whether or not new shape is shown in the legend.
- The ‘showlegend’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
visible¶
Determines whether or not new shape is visible. If
“legendonly”, the shape is not drawn, but can appear as a
legend item (provided that the legend itself is visible).
- The ‘visible’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, ‘legendonly’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Polar(arg=None, angularaxis=None, bargap=None, barmode=None, bgcolor=None, domain=None, gridshape=None, hole=None, radialaxis=None, sector=None, uirevision=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
angularaxis¶
The ‘angularaxis’ property is an instance of AngularAxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.polar.AngularAxis
-
property
bargap¶
Sets the gap between bars of adjacent location coordinates.
Values are unitless, they represent fractions of the minimum
difference in bar positions in the data.
- The ‘bargap’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
barmode¶
Determines how bars at the same location coordinate are
displayed on the graph. With “stack”, the bars are stacked on
top of one another With “overlay”, the bars are plotted over
one another, you might need to reduce “opacity” to see multiple
bars.
- The ‘barmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘stack’, ‘overlay’]
- Returns
-
- Return type
Any
-
property
bgcolor¶
Set the background color of the subplot
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.polar.Domain
-
property
gridshape¶
Determines if the radial axis grid lines and angular axis line
are drawn as “circular” sectors or as “linear” (polygon)
sectors. Has an effect only when the angular axis has type
“category”. Note that radialaxis.angle is snapped to the
angle of the closest vertex when gridshape is “circular” (so
that radial axis scale is the same as the data scale).
- The ‘gridshape’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘circular’, ‘linear’]
- Returns
-
- Return type
Any
-
property
hole¶
Sets the fraction of the radius to cut out of the polar
subplot.
- The ‘hole’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
radialaxis¶
The ‘radialaxis’ property is an instance of RadialAxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.polar.RadialAxis
-
property
sector¶
- Sets angular span of this polar subplot with two angles (in
degrees). Sector are assumed to be spanned in the
counterclockwise direction with 0 corresponding to rightmost
limit of the polar subplot.
The ‘sector’ property is an info array that may be specified as:
- The ‘sector[0]’ property is a number and may be specified as:
-
- The ‘sector[1]’ property is a number and may be specified as:
-
list
-
property
uirevision¶
Controls persistence of user-driven changes in axis attributes,
if not overridden in the individual axes. Defaults to
layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Scene(arg=None, annotations=None, annotationdefaults=None, aspectmode=None, aspectratio=None, bgcolor=None, camera=None, domain=None, dragmode=None, hovermode=None, uirevision=None, xaxis=None, yaxis=None, zaxis=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
annotationdefaults¶
When used in a template (as
layout.template.layout.scene.annotationdefaults), sets the
default property values to use for elements of
layout.scene.annotations
The ‘annotationdefaults’ property is an instance of Annotation
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.Annotation
-
property
annotations¶
The ‘annotations’ property is a tuple of instances of
Annotation that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.layout.scene.Annotation]
-
property
aspectmode¶
If “cube”, this scene’s axes are drawn as a cube, regardless of
the axes’ ranges. If “data”, this scene’s axes are drawn in
proportion with the axes’ ranges. If “manual”, this scene’s
axes are drawn in proportion with the input of “aspectratio”
(the default behavior if “aspectratio” is provided). If “auto”,
this scene’s axes are drawn using the results of “data” except
when one axis is more than four times the size of the two
others, where in that case the results of “cube” are used.
- The ‘aspectmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘cube’, ‘data’, ‘manual’]
- Returns
-
- Return type
Any
-
property
aspectratio¶
Sets this scene’s axis aspectratio.
The ‘aspectratio’ property is an instance of Aspectratio
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.Aspectratio
-
property
bgcolor¶
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
camera¶
The ‘camera’ property is an instance of Camera
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.Camera
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.Domain
-
property
dragmode¶
Determines the mode of drag interactions for this scene.
- The ‘dragmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘orbit’, ‘turntable’, ‘zoom’, ‘pan’, False]
- Returns
-
- Return type
Any
-
property
hovermode¶
Determines the mode of hover interactions for this scene.
- The ‘hovermode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘closest’, False]
- Returns
-
- Return type
Any
-
property
uirevision¶
Controls persistence of user-driven changes in camera
attributes. Defaults to layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
xaxis¶
The ‘xaxis’ property is an instance of XAxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.XAxis
-
property
yaxis¶
The ‘yaxis’ property is an instance of YAxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.YAxis
-
property
zaxis¶
The ‘zaxis’ property is an instance of ZAxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.scene.ZAxis
-
class
plotly.graph_objects.layout.Selection(arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.selection.Line
-
property
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.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of the selection.
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
path¶
For type “path” - a valid SVG path similar to shapes.path
in data coordinates. Allowed segments are: M, L and Z.
- The ‘path’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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.
- The ‘templateitemname’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
type¶
Specifies the selection type to be drawn. If “rect”, a
rectangle is drawn linking (x0,`y0`), (x1,`y0`),
(x1,`y1`) and (x0,`y1`). If “path”, draw a custom SVG path
using path.
- The ‘type’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘rect’, ‘path’]
- Returns
-
- Return type
Any
-
property
x0¶
Sets the selection’s starting x position.
The ‘x0’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
x1¶
Sets the selection’s end x position.
The ‘x1’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
xref¶
Sets the selection’s x coordinate axis. If set to a x axis id
(e.g. “x” or “x2”), the x position refers to a x coordinate.
If set to “paper”, the x position refers to the distance from
the left of the plotting area in normalized coordinates where 0
(1) corresponds to the left (right). If set to a x axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the left of the domain of
that axis: e.g., x2 domain refers to the domain of the second
x axis and a x position of 0.5 refers to the point between the
left and the right of the domain of the second x axis.
- The ‘xref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘paper’]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
y0¶
Sets the selection’s starting y position.
The ‘y0’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
y1¶
Sets the selection’s end y position.
The ‘y1’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
yref¶
Sets the selection’s x coordinate axis. If set to a y axis id
(e.g. “y” or “y2”), the y position refers to a y coordinate.
If set to “paper”, the y position refers to the distance from
the bottom of the plotting area in normalized coordinates where
0 (1) corresponds to the bottom (top). If set to a y axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the bottom of the domain of
that axis: e.g., y2 domain refers to the domain of the second
y axis and a y position of 0.5 refers to the point between the
bottom and the top of the domain of the second y axis.
- The ‘yref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘paper’]
- A string that matches one of the following regular expressions:
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Shape(arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
editable¶
Determines whether the shape could be activated for edit or
not. Has no effect when the older editable shapes mode is
enabled via config.editable or config.edits.shapePosition.
- The ‘editable’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
fillcolor¶
Sets the color filling the shape’s interior. Only applies to
closed shapes.
- The ‘fillcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
fillrule¶
Determines which regions of complex paths constitute the
interior. For more info please visit
https://developer.mozilla.org/en-
US/docs/Web/SVG/Attribute/fill-rule
- The ‘fillrule’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘evenodd’, ‘nonzero’]
- Returns
-
- Return type
Any
-
property
label¶
The ‘label’ property is an instance of Label
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.shape.Label
-
property
layer¶
Specifies whether shapes are drawn below gridlines (“below”),
between gridlines and traces (“between”) or above traces
(“above”).
- The ‘layer’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘below’, ‘above’, ‘between’]
- Returns
-
- Return type
Any
-
property
legend¶
Sets the reference to a legend to show this shape in.
References to these legends are “legend”, “legend2”, “legend3”,
etc. Settings for these legends are set in the layout, under
layout.legend, layout.legend2, etc.
The ‘legend’ property is an identifier of a particular
subplot, of type ‘legend’, that may be specified as:
the string ‘legend’ optionally followed by an integer >= 1
(e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)
- Returns
-
- Return type
str
-
property
legendgroup¶
Sets the legend group for this shape. Traces and shapes part of
the same legend group hide/show at the same time when toggling
legend items.
- The ‘legendgroup’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
legendgrouptitle¶
The ‘legendgrouptitle’ property is an instance of Legendgrouptitle
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.shape.Legendgrouptitle
-
property
legendrank¶
Sets the legend rank for this shape. Items and groups with
smaller ranks are presented on top/left side while with
“reversed” legend.traceorder they are on bottom/right side.
The default legendrank is 1000, so that you can use ranks less
than 1000 to place certain items before all unranked items, and
ranks greater than 1000 to go after all unranked items. When
having unranked or equal rank items shapes would be displayed
after traces i.e. according to their order in data and layout.
- The ‘legendrank’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
legendwidth¶
Sets the width (in px or fraction) of the legend for this
shape.
- The ‘legendwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.shape.Line
-
property
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.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
opacity¶
Sets the opacity of the shape.
- The ‘opacity’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
path¶
For type “path” - a valid SVG path with the pixel values
replaced by data values in xsizemode/ysizemode being
“scaled” and taken unmodified as pixels relative to xanchor
and yanchor in case of “pixel” size mode. There are a few
restrictions / quirks only absolute instructions, not relative.
So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs
(A) are not allowed because radius rx and ry are relative. In
the future we could consider supporting relative commands, but
we would have to decide on how to handle date and log axes.
Note that even as is, Q and C Bezier paths that are smooth on
linear axes may not be smooth on log, and vice versa. no
chained “polybezier” commands - specify the segment type for
each one. On category axes, values are numbers scaled to the
serial numbers of categories because using the categories
themselves there would be no way to describe fractional
positions On data axes: because space and T are both normal
components of path strings, we can’t use either to separate
date from time parts. Therefore we’ll use underscore for this
purpose: 2015-02-21_13:45:56.789
- The ‘path’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
showlegend¶
Determines whether or not this shape is shown in the legend.
- The ‘showlegend’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
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.
- The ‘templateitemname’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
type¶
Specifies the shape type to be drawn. If “line”, a line is
drawn from (x0,`y0`) to (x1,`y1`) with respect to the axes’
sizing mode. If “circle”, a circle is drawn from
((x0`+`x1)/2, (y0`+`y1)/2)) with radius (|(`x0`+`x1`)/2 -
`x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes’ sizing
mode. If “rect”, a rectangle is drawn linking (x0,`y0`),
(x1,`y0`), (x1,`y1`), (x0,`y1`), (x0,`y0`) with respect
to the axes’ sizing mode. If “path”, draw a custom SVG path
using path. with respect to the axes’ sizing mode.
- The ‘type’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘circle’, ‘rect’, ‘path’, ‘line’]
- Returns
-
- Return type
Any
-
property
visible¶
Determines whether or not this shape is visible. If
“legendonly”, the shape is not drawn, but can appear as a
legend item (provided that the legend itself is visible).
- The ‘visible’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, ‘legendonly’]
- Returns
-
- Return type
Any
-
property
x0¶
Sets the shape’s starting x position. See type and
xsizemode for more info.
The ‘x0’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
x0shift¶
Shifts x0 away from the center of the category when xref is
a “category” or “multicategory” axis. -0.5 corresponds to the
start of the category and 0.5 corresponds to the end of the
category.
- The ‘x0shift’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
x1¶
Sets the shape’s end x position. See type and xsizemode for
more info.
The ‘x1’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
x1shift¶
Shifts x1 away from the center of the category when xref is
a “category” or “multicategory” axis. -0.5 corresponds to the
start of the category and 0.5 corresponds to the end of the
category.
- The ‘x1shift’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
xanchor¶
Only relevant in conjunction with xsizemode set to “pixel”.
Specifies the anchor point on the x axis to which x0, x1
and x coordinates within path are relative to. E.g. useful to
attach a pixel sized shape to a certain data value. No effect
when xsizemode not set to “pixel”.
The ‘xanchor’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
xref¶
Sets the shape’s x coordinate axis. If set to a x axis id (e.g.
“x” or “x2”), the x position refers to a x coordinate. If set
to “paper”, the x position refers to the distance from the
left of the plotting area in normalized coordinates where 0 (1)
corresponds to the left (right). If set to a x axis ID followed
by “domain” (separated by a space), the position behaves like
for “paper”, but refers to the distance in fractions of the
domain length from the left of the domain of that axis: e.g.,
x2 domain refers to the domain of the second x axis and a x
position of 0.5 refers to the point between the left and the
right of the domain of the second x axis. If an array of axis
IDs is provided, each x value will refer to the corresponding
axis, e.g., [‘x’, ‘x2’] for a rectangle, line, or circle means
x0 uses the x axis and x1 uses the x2 axis. Path shapes
using an array should have one entry for each x coordinate in
the string.
- The ‘xref’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
xsizemode¶
Sets the shapes’s sizing mode along the x axis. If set to
“scaled”, x0, x1 and x coordinates within path refer to
data values on the x axis or a fraction of the plot area’s
width (xref set to “paper”). If set to “pixel”, xanchor
specifies the x position in terms of data or plot fraction but
x0, x1 and x coordinates within path are pixels relative
to xanchor. This way, the shape can have a fixed width while
maintaining a position relative to data or plot fraction. Note:
xsizemode “pixel” is not supported when xref is an array.
- The ‘xsizemode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘scaled’, ‘pixel’]
- Returns
-
- Return type
Any
-
property
y0¶
Sets the shape’s starting y position. See type and
ysizemode for more info.
The ‘y0’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
y0shift¶
Shifts y0 away from the center of the category when yref is
a “category” or “multicategory” axis. -0.5 corresponds to the
start of the category and 0.5 corresponds to the end of the
category.
- The ‘y0shift’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
y1¶
Sets the shape’s end y position. See type and ysizemode for
more info.
The ‘y1’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
y1shift¶
Shifts y1 away from the center of the category when yref is
a “category” or “multicategory” axis. -0.5 corresponds to the
start of the category and 0.5 corresponds to the end of the
category.
- The ‘y1shift’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
yanchor¶
Only relevant in conjunction with ysizemode set to “pixel”.
Specifies the anchor point on the y axis to which y0, y1
and y coordinates within path are relative to. E.g. useful to
attach a pixel sized shape to a certain data value. No effect
when ysizemode not set to “pixel”.
The ‘yanchor’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
yref¶
Sets the shape’s y coordinate axis. If set to a y axis id (e.g.
“y” or “y2”), the y position refers to a y coordinate. If set
to “paper”, the y position refers to the distance from the
bottom of the plotting area in normalized coordinates where 0
(1) corresponds to the bottom (top). If set to a y axis ID
followed by “domain” (separated by a space), the position
behaves like for “paper”, but refers to the distance in
fractions of the domain length from the bottom of the domain of
that axis: e.g., y2 domain refers to the domain of the second
y axis and a y position of 0.5 refers to the point between the
bottom and the top of the domain of the second y axis. If an
array of axis IDs is provided, each y value will refer to the
corresponding axis, e.g., [‘y’, ‘y2’] for a rectangle, line, or
circle means y0 uses the y axis and y1 uses the y2
axis. Path shapes using an array should have one entry for each
y coordinate in the string.
- The ‘yref’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
ysizemode¶
Sets the shapes’s sizing mode along the y axis. If set to
“scaled”, y0, y1 and y coordinates within path refer to
data values on the y axis or a fraction of the plot area’s
height (yref set to “paper”). If set to “pixel”, yanchor
specifies the y position in terms of data or plot fraction but
y0, y1 and y coordinates within path are pixels relative
to yanchor. This way, the shape can have a fixed height while
maintaining a position relative to data or plot fraction. Note:
ysizemode “pixel” is not supported when yref is an array.
- The ‘ysizemode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘scaled’, ‘pixel’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Slider(arg=None, active=None, activebgcolor=None, bgcolor=None, bordercolor=None, borderwidth=None, currentvalue=None, font=None, len=None, lenmode=None, minorticklen=None, name=None, pad=None, steps=None, stepdefaults=None, templateitemname=None, tickcolor=None, ticklen=None, tickwidth=None, transition=None, visible=None, x=None, xanchor=None, y=None, yanchor=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
active¶
Determines which button (by index starting from 0) is
considered active.
- The ‘active’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
activebgcolor¶
Sets the background color of the slider grip while dragging.
- The ‘activebgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bgcolor¶
Sets the background color of the slider.
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bordercolor¶
Sets the color of the border enclosing the slider.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
borderwidth¶
Sets the width (in px) of the border enclosing the slider.
- The ‘borderwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
currentvalue¶
The ‘currentvalue’ property is an instance of Currentvalue
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.slider.Currentvalue
-
property
font¶
Sets the font of the slider step labels.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.slider.Font
-
property
len¶
Sets the length of the slider This measure excludes the padding
of both ends. That is, the slider’s length is this length minus
the padding on both ends.
- The ‘len’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
lenmode¶
Determines whether this slider length is set in units of plot
“fraction” or in *pixels. Use len to set the value.
- The ‘lenmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘fraction’, ‘pixels’]
- Returns
-
- Return type
Any
-
property
minorticklen¶
Sets the length in pixels of minor step tick marks
- The ‘minorticklen’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
pad¶
Set the padding of the slider component along each side.
The ‘pad’ property is an instance of Pad
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.slider.Pad
-
property
stepdefaults¶
When used in a template (as
layout.template.layout.slider.stepdefaults), sets the default
property values to use for elements of layout.slider.steps
The ‘stepdefaults’ property is an instance of Step
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.slider.Step
-
property
steps¶
The ‘steps’ property is a tuple of instances of
Step that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.layout.slider.Step]
-
property
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.
- The ‘templateitemname’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
tickcolor¶
Sets the color of the border enclosing the slider.
- The ‘tickcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
ticklen¶
Sets the length in pixels of step tick marks
- The ‘ticklen’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
tickwidth¶
Sets the tick width (in px).
- The ‘tickwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
transition¶
The ‘transition’ property is an instance of Transition
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.slider.Transition
-
property
visible¶
Determines whether or not the slider is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
x¶
Sets the x position (in normalized coordinates) of the slider.
- The ‘x’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
xanchor¶
Sets the slider’s horizontal position anchor. This anchor binds
the x position to the “left”, “center” or “right” of the
range selector.
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
y¶
Sets the y position (in normalized coordinates) of the slider.
- The ‘y’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
yanchor¶
Sets the slider’s vertical position anchor This anchor binds
the y position to the “top”, “middle” or “bottom” of the
range selector.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Smith(arg=None, bgcolor=None, domain=None, imaginaryaxis=None, realaxis=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
bgcolor¶
Set the background color of the subplot
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.smith.Domain
-
property
imaginaryaxis¶
The ‘imaginaryaxis’ property is an instance of Imaginaryaxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.smith.Imaginaryaxis
-
property
realaxis¶
The ‘realaxis’ property is an instance of Realaxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.smith.Realaxis
-
class
plotly.graph_objects.layout.Template(arg=None, data=None, layout=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
data¶
The ‘data’ property is an instance of Data
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.template.Data
-
property
layout¶
The ‘layout’ property is an instance of Layout
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.template.Layout
-
class
plotly.graph_objects.layout.Ternary(arg=None, aaxis=None, baxis=None, bgcolor=None, caxis=None, domain=None, sum=None, uirevision=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
aaxis¶
The ‘aaxis’ property is an instance of Aaxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.ternary.Aaxis
-
property
baxis¶
The ‘baxis’ property is an instance of Baxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.ternary.Baxis
-
property
bgcolor¶
Set the background color of the subplot
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
caxis¶
The ‘caxis’ property is an instance of Caxis
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.ternary.Caxis
-
property
domain¶
The ‘domain’ property is an instance of Domain
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.ternary.Domain
-
property
sum¶
The number each triplet should sum to, and the maximum range of
each axis
- The ‘sum’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
uirevision¶
Controls persistence of user-driven changes in axis min and
title, if not overridden in the individual axes. Defaults to
layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Title(arg=None, automargin=None, font=None, pad=None, subtitle=None, text=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
automargin¶
Determines whether the title can automatically push the figure
margins. If yref='paper' then the margin will expand to
ensure that the title doesn’t overlap with the edges of the
container. If yref='container' then the margins will ensure
that the title doesn’t overlap with the plot area, tick labels,
and axis titles. If automargin=true and the margins need to
be expanded, then y will be set to a default 1 and yanchor will
be set to an appropriate default to ensure that minimal margin
space is needed. Note that when yref='paper', only 1 or 0 are
allowed y values. Invalid values will be reset to the default
1.
- The ‘automargin’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
font¶
Sets the title font.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.title.Font
-
property
pad¶
Sets the padding of the title. Each padding value only applies
when the corresponding xanchor/yanchor value is set
accordingly. E.g. for left padding to take effect, xanchor
must be set to “left”. The same rule applies if
xanchor/yanchor is determined automatically. Padding is
muted if the respective anchor value is “middle*/*center”.
The ‘pad’ property is an instance of Pad
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.title.Pad
-
property
subtitle¶
The ‘subtitle’ property is an instance of Subtitle
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.title.Subtitle
-
property
text¶
Sets the plot’s title.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
x¶
Sets the x position with respect to xref in normalized
coordinates from 0 (left) to 1 (right).
- The ‘x’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
xanchor¶
Sets the title’s horizontal alignment with respect to its x
position. “left” means that the title starts at x, “right”
means that the title ends at x and “center” means that the
title’s center is at x. “auto” divides xref by three and
calculates the xanchor value automatically based on the value
of x.
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
xref¶
Sets the container x refers to. “container” spans the entire
width of the plot. “paper” refers to the width of the
plotting area only.
- The ‘xref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘container’, ‘paper’]
- Returns
-
- Return type
Any
-
property
y¶
Sets the y position with respect to yref in normalized
coordinates from 0 (bottom) to 1 (top). “auto” places the
baseline of the title onto the vertical center of the top
margin.
- The ‘y’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
yanchor¶
Sets the title’s vertical alignment with respect to its y
position. “top” means that the title’s cap line is at y,
“bottom” means that the title’s baseline is at y and “middle”
means that the title’s midline is at y. “auto” divides yref
by three and calculates the yanchor value automatically based
on the value of y.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
yref¶
Sets the container y refers to. “container” spans the entire
height of the plot. “paper” refers to the height of the
plotting area only.
- The ‘yref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘container’, ‘paper’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Transition(arg=None, duration=None, easing=None, ordering=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
duration¶
The duration of the transition, in milliseconds. If equal to
zero, updates are synchronous.
- The ‘duration’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
easing¶
The easing function used for the transition
- The ‘easing’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘linear’, ‘quad’, ‘cubic’, ‘sin’, ‘exp’, ‘circle’,
‘elastic’, ‘back’, ‘bounce’, ‘linear-in’, ‘quad-in’,
‘cubic-in’, ‘sin-in’, ‘exp-in’, ‘circle-in’, ‘elastic-in’,
‘back-in’, ‘bounce-in’, ‘linear-out’, ‘quad-out’,
‘cubic-out’, ‘sin-out’, ‘exp-out’, ‘circle-out’,
‘elastic-out’, ‘back-out’, ‘bounce-out’, ‘linear-in-out’,
‘quad-in-out’, ‘cubic-in-out’, ‘sin-in-out’, ‘exp-in-out’,
‘circle-in-out’, ‘elastic-in-out’, ‘back-in-out’,
‘bounce-in-out’]
- Returns
-
- Return type
Any
-
property
ordering¶
Determines whether the figure’s layout or traces smoothly
transitions during updates that make both traces and layout
change.
- The ‘ordering’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘layout first’, ‘traces first’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Uniformtext(arg=None, minsize=None, mode=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
minsize¶
Sets the minimum text size between traces of the same type.
- The ‘minsize’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
mode¶
Determines how the font size for various text elements are
uniformed between each trace type. If the computed text sizes
were smaller than the minimum size defined by
uniformtext.minsize using “hide” option hides the text; and
using “show” option shows the text without further downscaling.
Please note that if the size defined by minsize is greater
than the font size defined by trace, then the minsize is
used.
- The ‘mode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, ‘hide’, ‘show’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.Updatemenu(arg=None, active=None, bgcolor=None, bordercolor=None, borderwidth=None, buttons=None, buttondefaults=None, direction=None, font=None, name=None, pad=None, showactive=None, templateitemname=None, type=None, visible=None, x=None, xanchor=None, y=None, yanchor=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
active¶
Determines which button (by index starting from 0) is
considered active.
- The ‘active’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
bgcolor¶
Sets the background color of the update menu buttons.
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bordercolor¶
Sets the color of the border enclosing the update menu.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
borderwidth¶
Sets the width (in px) of the border enclosing the update menu.
- The ‘borderwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
buttondefaults¶
When used in a template (as
layout.template.layout.updatemenu.buttondefaults), sets the
default property values to use for elements of
layout.updatemenu.buttons
The ‘buttondefaults’ property is an instance of Button
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.updatemenu.Button
-
property
buttons¶
The ‘buttons’ property is a tuple of instances of
Button that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.layout.updatemenu.Button]
-
property
direction¶
Determines the direction in which the buttons are laid out,
whether in a dropdown menu or a row/column of buttons. For
left and up, the buttons will still appear in left-to-right
or top-to-bottom order respectively.
- The ‘direction’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘right’, ‘up’, ‘down’]
- Returns
-
- Return type
Any
-
property
font¶
Sets the font of the update menu button text.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.updatemenu.Font
-
property
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.
- The ‘name’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
pad¶
Sets the padding around the buttons or dropdown menu.
The ‘pad’ property is an instance of Pad
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.updatemenu.Pad
-
property
showactive¶
Highlights active dropdown item or active button if true.
- The ‘showactive’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
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.
- The ‘templateitemname’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
type¶
Determines whether the buttons are accessible via a dropdown
menu or whether the buttons are stacked horizontally or
vertically
- The ‘type’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘dropdown’, ‘buttons’]
- Returns
-
- Return type
Any
-
property
visible¶
Determines whether or not the update menu is visible.
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
x¶
Sets the x position (in normalized coordinates) of the update
menu.
- The ‘x’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
xanchor¶
Sets the update menu’s horizontal position anchor. This anchor
binds the x position to the “left”, “center” or “right” of
the range selector.
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
y¶
Sets the y position (in normalized coordinates) of the update
menu.
- The ‘y’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
yanchor¶
Sets the update menu’s vertical position anchor This anchor
binds the y position to the “top”, “middle” or “bottom” of
the range selector.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.layout.XAxis(arg=None, anchor=None, automargin=None, autorange=None, autorangeoptions=None, autotickangles=None, autotypenumbers=None, calendar=None, categoryarray=None, categoryorder=None, color=None, constrain=None, constraintoward=None, dividercolor=None, dividerwidth=None, domain=None, dtick=None, exponentformat=None, fixedrange=None, gridcolor=None, griddash=None, gridwidth=None, hoverformat=None, insiderange=None, labelalias=None, layer=None, linecolor=None, linewidth=None, matches=None, maxallowed=None, minallowed=None, minexponent=None, minor=None, minorloglabels=None, mirror=None, modebardisable=None, nticks=None, overlaying=None, position=None, range=None, rangebreaks=None, rangebreakdefaults=None, rangemode=None, rangeselector=None, rangeslider=None, scaleanchor=None, scaleratio=None, separatethousands=None, showdividers=None, showexponent=None, showgrid=None, showline=None, showspikes=None, showticklabels=None, showtickprefix=None, showticksuffix=None, side=None, spikecolor=None, spikedash=None, spikemode=None, spikesnap=None, spikethickness=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklabelindex=None, ticklabelmode=None, ticklabeloverflow=None, ticklabelposition=None, ticklabelshift=None, ticklabelstandoff=None, ticklabelstep=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, tickson=None, ticksuffix=None, ticktext=None, tickvals=None, tickwidth=None, title=None, type=None, uirevision=None, unifiedhovertitle=None, visible=None, zeroline=None, zerolinecolor=None, zerolinelayer=None, zerolinewidth=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseLayoutHierarchyType
-
property
anchor¶
If set to an opposite-letter axis id (e.g. x2, y), this
axis is bound to the corresponding opposite-letter axis. If set
to “free”, this axis’ position is determined by position.
- The ‘anchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘free’]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’,
‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
automargin¶
Determines whether long tick labels automatically grow the
figure margins.
The ‘automargin’ property is a flaglist and may be specified
as a string containing:
Any combination of [‘height’, ‘width’, ‘left’, ‘right’, ‘top’, ‘bottom’] joined with ‘+’ characters
(e.g. ‘height+width’)
OR exactly one of [True, False] (e.g. ‘False’)
- Returns
-
- Return type
Any
-
property
autorange¶
Determines whether or not the range of this axis is computed in
relation to the input data. See rangemode for more info. If
range is provided and it has a value for both the lower and
upper bound, autorange is set to False. Using “min” applies
autorange only to set the minimum. Using “max” applies
autorange only to set the maximum. Using min reversed applies
autorange only to set the minimum on a reversed axis. Using
max reversed applies autorange only to set the maximum on a
reversed axis. Using “reversed” applies autorange on both ends
and reverses the axis direction.
- The ‘autorange’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, ‘reversed’, ‘min reversed’, ‘max reversed’,
‘min’, ‘max’]
- Returns
-
- Return type
Any
-
property
autorangeoptions¶
The ‘autorangeoptions’ property is an instance of Autorangeoptions
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Autorangeoptions
-
property
autotickangles¶
When tickangle is set to “auto”, it will be set to the first
angle in this array that is large enough to prevent label
overlap.
The ‘autotickangles’ property is an info array that may be specified as:
* a list of elements where:
The ‘autotickangles[i]’ property is a angle (in degrees) that may be
specified as a number between -180 and 180.
Numeric values outside this range are converted to the equivalent value
(e.g. 270 is converted to -90).
- Returns
-
- Return type
list
-
property
autotypenumbers¶
Using “strict” a numeric string in trace data is not converted
to a number. Using convert types a numeric string in trace
data may be treated as a number during automatic axis type
detection. Defaults to layout.autotypenumbers.
- The ‘autotypenumbers’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘convert types’, ‘strict’]
- Returns
-
- Return type
Any
-
property
calendar¶
Sets the calendar system to use for range and tick0 if this
is a date axis. This does not set the calendar for interpreting
data on this axis, that’s specified in the trace or via the
global layout.calendar
- The ‘calendar’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’,
‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’,
‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’,
‘thai’, ‘ummalqura’]
- Returns
-
- Return type
Any
-
property
categoryarray¶
Sets the order in which categories on this axis appear. Only
has an effect if categoryorder is set to “array”. Used with
categoryorder.
The ‘categoryarray’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
- Returns
-
- Return type
numpy.ndarray
-
property
categoryorder¶
Specifies the ordering logic for the case of categorical
variables. By default, plotly uses “trace”, which specifies the
order that is present in the data supplied. Set categoryorder
to category ascending or category descending if order
should be determined by the alphanumerical order of the
category names. Set categoryorder to “array” to derive the
ordering from the attribute categoryarray. If a category is
not found in the categoryarray array, the sorting behavior
for that attribute will be identical to the “trace” mode. The
unspecified categories will follow the categories in
categoryarray. Set categoryorder to total ascending or
total descending if order should be determined by the
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean, geometric mean or median
of all the values.
- The ‘categoryorder’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’,
‘array’, ‘total ascending’, ‘total descending’, ‘min
ascending’, ‘min descending’, ‘max ascending’, ‘max
descending’, ‘sum ascending’, ‘sum descending’, ‘mean
ascending’, ‘mean descending’, ‘geometric mean ascending’,
‘geometric mean descending’, ‘median ascending’, ‘median
descending’]
- Returns
-
- Return type
Any
-
property
color¶
Sets default for all colors associated with this axis all at
once: line, font, tick, and grid colors. Grid color is
lightened by blending this with the plot background Individual
pieces can override this.
- The ‘color’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
constrain¶
If this axis needs to be compressed (either due to its own
scaleanchor and scaleratio or those of the other axis),
determines how that happens: by increasing the “range”, or by
decreasing the “domain”. Default is “domain” for axes
containing image traces, “range” otherwise.
- The ‘constrain’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘range’, ‘domain’]
- Returns
-
- Return type
Any
-
property
constraintoward¶
If this axis needs to be compressed (either due to its own
scaleanchor and scaleratio or those of the other axis),
determines which direction we push the originally specified
plot area. Options are “left”, “center” (default), and “right”
for x axes, and “top”, “middle” (default), and “bottom” for y
axes.
- The ‘constraintoward’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘center’, ‘right’, ‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
dividercolor¶
Sets the color of the dividers Only has an effect on
“multicategory” axes.
- The ‘dividercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
dividerwidth¶
Sets the width (in px) of the dividers Only has an effect on
“multicategory” axes.
- The ‘dividerwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
domain¶
Sets the domain of this axis (in plot fraction).
The ‘domain’ property is an info array that may be specified as:
- The ‘domain[0]’ property is a number and may be specified as:
-
- The ‘domain[1]’ property is a number and may be specified as:
-
list
-
property
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
- Returns
-
- Return type
Any
-
property
exponentformat¶
Determines a formatting rule for the tick exponents. For
example, consider the number 1,000,000,000. If “none”, it
appears as 1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If
“power”, 1x10^9 (with 9 in a super script). If “SI”, 1G. If
“B”, 1B. “SI” uses prefixes from “femto” f (10^-15) to “tera” T
(10^12). SI extended covers instead the full SI range from
“quecto” q (10^-30) to “quetta” Q (10^30). If “SI” or SI
extended is used and the exponent is beyond the above ranges,
the formatting rule will automatically be switched to the power
notation.
- The ‘exponentformat’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’, ‘SI extended’]
- Returns
-
- Return type
Any
-
property
fixedrange¶
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
- The ‘fixedrange’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
gridcolor¶
Sets the color of the grid lines.
- The ‘gridcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
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”).
- 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
-
- Return type
str
-
property
gridwidth¶
Sets the width (in px) of the grid lines.
- The ‘gridwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
hoverformat¶
Sets the hover text formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
dates see: https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format. We add two items to d3’s date
formatter: “%h” for half of the year as a decimal number as
well as “%{n}f” for fractional seconds with n digits. For
example, 2016-10-13 09:15:23.456 with tickformat
“%H~%M~%S.%2f” would display “09~15~23.46”
- The ‘hoverformat’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
insiderange¶
- Could be used to set the desired inside range of this axis
(excluding the labels) when ticklabelposition of the anchored
axis has “inside”. Not implemented for axes with type “log”.
This would be ignored when range is provided.
The ‘insiderange’ property is an info array that may be specified as:
The ‘insiderange[0]’ property accepts values of any type The ‘insiderange[1]’ property accepts values of any type
list
-
property
labelalias¶
Replacement text for specific tick or hover labels. For example
using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to
Canada. The labels we would have shown must match the keys
exactly, after adding any tickprefix or ticksuffix. For
negative numbers the minus sign symbol used (U+2212) is wider
than the regular ascii dash. That means you need to use −1
instead of -1. labelalias can be used with any axis type, and
both keys (if needed) and values (if desired) can include html-
like tags or MathJax.
The ‘labelalias’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
layer¶
Sets the layer on which this axis is displayed. If above
traces, this axis is displayed above all the subplot’s traces
If below traces, this axis is displayed below all the
subplot’s traces, but above the grid lines. Useful when used
together with scatter-like traces with cliponaxis set to
False to show markers and/or text nodes above this axis.
- The ‘layer’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘above traces’, ‘below traces’]
- Returns
-
- Return type
Any
-
property
linecolor¶
Sets the axis line color.
- The ‘linecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
linewidth¶
Sets the width (in px) of the axis line.
- The ‘linewidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
matches¶
If set to another axis id (e.g. x2, y), the range of this
axis will match the range of the corresponding axis in data-
coordinates space. Moreover, matching axes share auto-range
values, category lists and histogram auto-bins. Note that
setting axes simultaneously in both a scaleanchor and a
matches constraint is currently forbidden. Moreover, note
that matching axes must have the same type.
- The ‘matches’ property is an enumeration that may be specified as:
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’,
‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
maxallowed¶
Determines the maximum range of this axis.
The ‘maxallowed’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
minallowed¶
Determines the minimum range of this axis.
The ‘minallowed’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
minexponent¶
Hide SI prefix for 10^n if |n| is below this number. This only
has an effect when tickformat is “SI” or “B”.
- The ‘minexponent’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
minor¶
The ‘minor’ property is an instance of Minor
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Minor
-
property
minorloglabels¶
Determines how minor log labels are displayed. If small
digits, small digits i.e. 2 or 5 are displayed. If “complete”,
complete digits are displayed. If “none”, no labels are
displayed.
- The ‘minorloglabels’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘small digits’, ‘complete’, ‘none’]
- Returns
-
- Return type
Any
-
property
mirror¶
Determines if the axis lines or/and ticks are mirrored to the
opposite side of the plotting area. If True, the axis lines are
mirrored. If “ticks”, the axis lines and ticks are mirrored. If
False, mirroring is disable. If “all”, axis lines are mirrored
on all shared-axes subplots. If “allticks”, axis lines and
ticks are mirrored on all shared-axes subplots.
- The ‘mirror’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, ‘ticks’, False, ‘all’, ‘allticks’]
- Returns
-
- Return type
Any
-
property
modebardisable¶
Disables certain modebar buttons for this axis. “autoscale”
disables the autoscale buttons, “zoominout” disables the zoom-
in and zoom-out buttons.
The ‘modebardisable’ property is a flaglist and may be specified
as a string containing:
- Returns
-
- Return type
Any
-
property
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”.
- The ‘nticks’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
overlaying¶
If set a same-letter axis id, this axis is overlaid on top of
the corresponding same-letter axis, with traces and axes
visible for both axes. If False, this axis does not overlay any
same-letter axes. In this case, for axes with overlapping
domains only the highest-numbered axis will be visible.
- The ‘overlaying’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘free’]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’,
‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
position¶
Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if anchor is set
to “free”.
- The ‘position’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
range¶
- Sets the range of this axis. If the axis
type is “log”, then you must take the log of your desired range (e.g. to set the
range from 1 to 100, set the range from 0 to 2). 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.
Leaving either or both elements null impacts the default
autorange.
The ‘range’ property is an info array that may be specified as:
The ‘range[0]’ property accepts values of any type The ‘range[1]’ property accepts values of any type
list
-
property
rangebreakdefaults¶
When used in a template (as
layout.template.layout.xaxis.rangebreakdefaults), sets the
default property values to use for elements of
layout.xaxis.rangebreaks
The ‘rangebreakdefaults’ property is an instance of Rangebreak
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Rangebreak
-
property
rangebreaks¶
The ‘rangebreaks’ property is a tuple of instances of
Rangebreak that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.layout.xaxis.Rangebreak]
-
property
rangemode¶
If “normal”, the range is computed in relation to the extrema
of the input data. If “tozero”, the range extends to 0,
regardless of the input data If “nonnegative”, the range is
non-negative, regardless of the input data. Applies only to
linear axes.
- The ‘rangemode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘tozero’, ‘nonnegative’]
- Returns
-
- Return type
Any
-
property
rangeselector¶
The ‘rangeselector’ property is an instance of Rangeselector
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Rangeselector
-
property
rangeslider¶
The ‘rangeslider’ property is an instance of Rangeslider
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Rangeslider
-
property
scaleanchor¶
If set to another axis id (e.g. x2, y), the range of this
axis changes together with the range of the corresponding axis
such that the scale of pixels per unit is in a constant ratio.
Both axes are still zoomable, but when you zoom one, the other
will zoom the same amount, keeping a fixed midpoint.
constrain and constraintoward determine how we enforce the
constraint. You can chain these, ie yaxis: {scaleanchor: *x*},
xaxis2: {scaleanchor: *y*} but you can only link axes of the
same type. The linked axis can have the opposite letter (to
constrain the aspect ratio) or the same letter (to match scales
across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis:
{scaleanchor: *y*} or longer) are redundant and the last
constraint encountered will be ignored to avoid possible
inconsistent constraints via scaleratio. Note that setting
axes simultaneously in both a scaleanchor and a matches
constraint is currently forbidden. Setting false allows to
remove a default constraint (occasionally, you may need to
prevent a default scaleanchor constraint from being applied,
eg. when having an image trace yaxis: {scaleanchor: "x"} is
set automatically in order for pixels to be rendered as
squares, setting yaxis: {scaleanchor: false} allows to remove
the constraint).
- The ‘scaleanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[False]
- A string that matches one of the following regular expressions:
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’,
‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
- Returns
-
- Return type
Any
-
property
scaleratio¶
If this axis is linked to another by scaleanchor, this
determines the pixel to unit scale ratio. For example, if this
value is 10, then every unit on this axis spans 10 times the
number of pixels as a unit on the linked axis. Use this for
example to create an elevation profile where the vertical scale
is exaggerated a fixed amount with respect to the horizontal.
- The ‘scaleratio’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
separatethousands¶
If “true”, even 4-digit integers are separated
- The ‘separatethousands’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showdividers¶
Determines whether or not a dividers are drawn between the
category levels of this axis. Only has an effect on
“multicategory” axes.
- The ‘showdividers’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showexponent¶
If “all”, all exponents are shown besides their significands.
If “first”, only the exponent of the first tick is shown. If
“last”, only the exponent of the last tick is shown. If “none”,
no exponents appear.
- The ‘showexponent’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]
- Returns
-
- Return type
Any
-
property
showgrid¶
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
- The ‘showgrid’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showline¶
Determines whether or not a line bounding this axis is drawn.
- The ‘showline’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showspikes¶
Determines whether or not spikes (aka droplines) are drawn for
this axis. Note that spikes will never be drawn when
hovermode is False.
- The ‘showspikes’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showticklabels¶
Determines whether or not the tick labels are drawn.
- The ‘showticklabels’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showtickprefix¶
If “all”, all tick labels are displayed with a prefix. If
“first”, only the first tick is displayed with a prefix. If
“last”, only the last tick is displayed with a suffix. If
“none”, tick prefixes are hidden.
- The ‘showtickprefix’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]
- Returns
-
- Return type
Any
-
property
showticksuffix¶
Same as showtickprefix but for tick suffixes.
- The ‘showticksuffix’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]
- Returns
-
- Return type
Any
-
property
side¶
Determines whether a x (y) axis is positioned at the “bottom”
(“left”) or “top” (“right”) of the plotting area.
- The ‘side’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top’, ‘bottom’, ‘left’, ‘right’]
- Returns
-
- Return type
Any
-
property
spikecolor¶
Sets the spike color. If undefined, will use the series color
- The ‘spikecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
spikedash¶
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 ‘spikedash’ 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
-
- Return type
str
-
property
spikemode¶
Determines the drawing mode for the spike line If “toaxis”, the
line is drawn from the data point to the axis the series is
plotted on. If “across”, the line is drawn across the entire
plot area, and supercedes “toaxis”. If “marker”, then a marker
dot is drawn on the axis the series is plotted on
The ‘spikemode’ property is a flaglist and may be specified
as a string containing:
- Returns
-
- Return type
Any
-
property
spikesnap¶
Determines whether spikelines are stuck to the cursor or to the
closest datapoints.
- The ‘spikesnap’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘data’, ‘cursor’, ‘hovered data’]
- Returns
-
- Return type
Any
-
property
spikethickness¶
Sets the spike line width in pixels.
- The ‘spikethickness’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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
- Returns
-
- Return type
Any
-
property
tickangle¶
Sets the angle of the tick labels with respect to the
horizontal. For example, a tickangle of -90 draws the tick
labels vertically.
The ‘tickangle’ property is a angle (in degrees) that may be
specified as a number between -180 and 180.
Numeric values outside this range are converted to the equivalent value
(e.g. 270 is converted to -90).
- Returns
-
- Return type
int|float
-
property
tickcolor¶
Sets the tick color.
- The ‘tickcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
tickfont¶
Sets the tick font.
The ‘tickfont’ property is an instance of Tickfont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Tickfont
-
property
tickformat¶
Sets the tick label formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
dates see: https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format. We add two items to d3’s date
formatter: “%h” for half of the year as a decimal number as
well as “%{n}f” for fractional seconds with n digits. For
example, 2016-10-13 09:15:23.456 with tickformat
“%H~%M~%S.%2f” would display “09~15~23.46”
- The ‘tickformat’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
tickformatstopdefaults¶
When used in a template (as
layout.template.layout.xaxis.tickformatstopdefaults), sets the
default property values to use for elements of
layout.xaxis.tickformatstops
The ‘tickformatstopdefaults’ property is an instance of Tickformatstop
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Tickformatstop
-
property
tickformatstops¶
The ‘tickformatstops’ property is a tuple of instances of
Tickformatstop that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.layout.xaxis.Tickformatstop]
-
property
ticklabelindex¶
Only for axes with type “date” or “linear”. Instead of
drawing the major tick label, draw the label for the minor tick
that is n positions away from the major tick. E.g. to always
draw the label for the minor tick before each major tick,
choose ticklabelindex -1. This is useful for date axes with
ticklabelmode “period” if you want to label the period that
ends with each major tick instead of the period that begins
there.
- The ‘ticklabelindex’ property is an integer and may be specified as:
An int (or float that will be cast to an int) A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|numpy.ndarray
-
property
ticklabelmode¶
Determines where tick labels are drawn with respect to their
corresponding ticks and grid lines. Only has an effect for axes
of type “date” When set to “period”, tick labels are drawn in
the middle of the period between ticks.
- The ‘ticklabelmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘instant’, ‘period’]
- Returns
-
- Return type
Any
-
property
ticklabeloverflow¶
Determines how we handle tick labels that would overflow either
the graph div or the domain of the axis. The default value for
inside tick labels is hide past domain. Otherwise on
“category” and “multicategory” axes the default is “allow”. In
other cases the default is hide past div.
- The ‘ticklabeloverflow’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘allow’, ‘hide past div’, ‘hide past domain’]
- Returns
-
- Return type
Any
-
property
ticklabelposition¶
Determines where tick labels are drawn with respect to the
axis. Please note that top or bottom has no effect on x axes or
when ticklabelmode is set to “period” or when tickson is
set to “boundaries”. Similarly, left or right has no effect on
y axes or when ticklabelmode is set to “period” or when
tickson is set to “boundaries”. Has no effect on
“multicategory” axes. When used on axes linked by matches or
scaleanchor, no extra padding for inside labels would be
added by autorange, so that the scales could match.
- The ‘ticklabelposition’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘outside’, ‘inside’, ‘outside top’, ‘inside top’,
‘outside left’, ‘inside left’, ‘outside right’, ‘inside
right’, ‘outside bottom’, ‘inside bottom’]
- Returns
-
- Return type
Any
-
property
ticklabelshift¶
Shifts the tick labels by the specified number of pixels in
parallel to the axis. Positive values move the labels in the
positive direction of the axis.
- The ‘ticklabelshift’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
ticklabelstandoff¶
Sets the standoff distance (in px) between the axis tick labels
and their default position. A positive ticklabelstandoff
moves the labels farther away from the plot area if
ticklabelposition is “outside”, and deeper into the plot area
if ticklabelposition is “inside”. A negative
ticklabelstandoff works in the opposite direction, moving
outside ticks towards the plot area and inside ticks towards
the outside. If the negative value is large enough, inside
ticks can even end up outside and vice versa.
- The ‘ticklabelstandoff’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
ticklabelstep¶
Sets the spacing between tick labels as compared to the spacing
between ticks. A value of 1 (default) means each tick gets a
label. A value of 2 means shows every 2nd label. A larger value
n means only every nth tick is labeled. tick0 determines
which labels are shown. Not implemented for axes with type
“log” or “multicategory”, or when tickmode is “array”.
- The ‘ticklabelstep’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
ticklen¶
Sets the tick length (in px).
- The ‘ticklen’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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). If “sync”, the
number of ticks will sync with the overlayed axis set by
overlaying property. When no other tick info is provided,
overlaying (non-categorical) axes default to “sync”, while
other axes default to “auto”.
- The ‘tickmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘linear’, ‘array’, ‘sync’]
- Returns
-
- Return type
Any
-
property
tickprefix¶
Sets a tick label prefix.
- The ‘tickprefix’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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.
- The ‘ticks’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘outside’, ‘inside’, ‘’]
- Returns
-
- Return type
Any
-
property
tickson¶
Determines where ticks and grid lines are drawn with respect to
their corresponding tick labels. Only has an effect for axes of
type “category” or “multicategory”. When set to “boundaries”,
ticks and grid lines are drawn half a category to the
left/bottom of labels.
- The ‘tickson’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘labels’, ‘boundaries’]
- Returns
-
- Return type
Any
-
property
ticksuffix¶
Sets a tick label suffix.
- The ‘ticksuffix’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
ticktext¶
Sets the text displayed at the ticks position via tickvals.
Only has an effect if tickmode is set to “array”. Used with
tickvals.
The ‘ticktext’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
- Returns
-
- Return type
numpy.ndarray
-
property
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
- Returns
-
- Return type
numpy.ndarray
-
property
tickwidth¶
Sets the tick width (in px).
- The ‘tickwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
title¶
The ‘title’ property is an instance of Title
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Title
-
property
type¶
Sets the axis type. By default, plotly attempts to determined
the axis type by looking into the data of the traces that
referenced the axis in question.
- The ‘type’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘-‘, ‘linear’, ‘log’, ‘date’, ‘category’,
‘multicategory’]
- Returns
-
- Return type
Any
-
property
uirevision¶
Controls persistence of user-driven changes in axis range,
autorange, and title if in editable: true configuration.
Defaults to layout.uirevision.
The ‘uirevision’ property accepts values of any type
- Returns
-
- Return type
Any
-
property
unifiedhovertitle¶
The ‘unifiedhovertitle’ property is an instance of Unifiedhovertitle
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.layout.xaxis.Unifiedhovertitle
-
property
visible¶
A single toggle to hide the axis while preserving interaction
like dragging. Default is true when a cheater plot is present
on the axis, otherwise false
- The ‘visible’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
zeroline¶
Determines whether or not a line is drawn at along the 0 value
of this axis. If True, the zero line is drawn on top of the
grid lines.
- The ‘zeroline’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
zerolinecolor¶
Sets the line color of the zero line.
- The ‘zerolinecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
zerolinelayer¶
Sets the layer on which this zeroline is displayed. If above
traces, this zeroline is displayed above all the subplot’s
traces If below traces, this zeroline is displayed below all
the subplot’s traces, but above the grid lines. Limitation:
“zerolinelayer” currently has no effect if the “zorder”
property is set on any trace.
- The ‘zerolinelayer’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘above traces’, ‘below traces’]
- Returns
-
- Return type
Any
-
property
zerolinewidth¶
Sets the width (in px) of the zero line.
- The ‘zerolinewidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.layout.YAxis(arg=None, anchor=None, automargin=None, autorange=None, autorangeoptions=None, autoshift=None, autotickangles=None, autotypenumbers=None, calendar=None, categoryarray=None, categoryorder=None, color=None, constrain=None, constraintoward=None, dividercolor=None, dividerwidth=None, domain=None, dtick=None, exponentformat=None, fixedrange=None, gridcolor=None, griddash=None, gridwidth=None, hoverformat=None, insiderange=None, labelalias=None, layer=None, linecolor=None, linewidth=None, matches=None, maxallowed=None, minallowed=None, minexponent=None, minor=None, minorloglabels=None, mirror=None, modebardisable=None, nticks=None, overlaying=None, position=None, range=None, rangebreaks=None, rangebreakdefaults=None, rangemode=None, scaleanchor=None, scaleratio=None, separatethousands=None, shift=None, showdividers=None[Page truncated to keep GeezerVison snappy.] |
