plotly.graph_objects.Layout¶plotly.graph_objects.Layout(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)¶__init__(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)¶Construct a new Layout object
arg – dict of properties compatible with this constructor or
an instance of plotly.graph_objects.Layout
activeselection – plotly.graph_objects.layout.Activeselection
instance or dict with compatible properties
activeshape – plotly.graph_objects.layout.Activeshape
instance or dict with compatible properties
annotations – A tuple of
plotly.graph_objects.layout.Annotation
instances or dicts with compatible properties
annotationdefaults – When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations
autosize – Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.
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. This is the default
value; however it could be overridden for individual
axes.
barcornerradius – Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).
bargap – Sets the gap (in plot fraction) between bars of adjacent location coordinates.
bargroupgap – Sets the gap (in plot fraction) between bars of the same location coordinate.
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 “relative”, the bars are stacked on top of one another, with negative values below the axis, positive values above With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.
barnorm – Sets the normalization for bar traces on the graph. With “fraction”, the value of each bar is divided by the sum of all values at that location coordinate. “percent” is the same but multiplied by 100 to show percentages.
boxgap – Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have “width” set.
boxgroupgap – Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have “width” set.
boxmode – Determines how boxes at the same location coordinate are displayed on the graph. If “group”, the boxes are plotted next to one another centered around the shared location. If “overlay”, the boxes are plotted over one another, you might need to set “opacity” to see them multiple boxes. Has no effect on traces that have “width” set.
calendar – Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
clickmode – Determines the mode of single click interactions.
“event” is the default value and emits the
plotly_click event. In addition this mode emits the
plotly_selected event in drag modes “lasso” and
“select”, but with no event data attached (kept for
compatibility reasons). The “select” flag enables
selecting single data points via click. This mode also
supports persistent selections, meaning that pressing
Shift while clicking, adds to / subtracts from an
existing selection. “select” with hovermode: “x” can
be confusing, consider explicitly setting hovermode:
“closest” when using this feature. Selection events are
sent accordingly as long as “event” flag is set as
well. When the “event” flag is missing, plotly_click
and plotly_selected events are not fired.
coloraxis – plotly.graph_objects.layout.Coloraxis instance
or dict with compatible properties
colorscale – plotly.graph_objects.layout.Colorscale
instance or dict with compatible properties
colorway – Sets the default trace colors.
computed – Placeholder for exporting automargin-impacting values
namely margin.t, margin.b, margin.l and
margin.r in “full-json” mode.
datarevision – If provided, a changed value tells Plotly.react that
one or more data arrays has changed. This way you can
modify arrays in-place rather than making a complete
new copy for an incremental change. If NOT provided,
Plotly.react assumes that data arrays are being
treated as immutable, thus any data array with a
different identity from its predecessor contains new
data.
dragmode – Determines the mode of drag interactions. “select” and “lasso” apply only to scatter traces with markers or text. “orbit” and “turntable” apply only to 3D scenes.
editrevision – Controls persistence of user-driven changes in
editable: true configuration, other than trace names
and axis titles. Defaults to layout.uirevision.
extendfunnelareacolors – If true, the funnelarea slice colors (whether given
by funnelareacolorway or inherited from colorway)
will be extended to three times its original length by
first repeating every color 20% lighter then each color
20% darker. This is intended to reduce the likelihood
of reusing the same color when you have many slices,
but you can set false to disable. Colors provided in
the trace, using marker.colors, are never extended.
extendiciclecolors – If true, the icicle slice colors (whether given by
iciclecolorway or inherited from colorway) will be
extended to three times its original length by first
repeating every color 20% lighter then each color 20%
darker. This is intended to reduce the likelihood of
reusing the same color when you have many slices, but
you can set false to disable. Colors provided in the
trace, using marker.colors, are never extended.
extendpiecolors – If true, the pie slice colors (whether given by
piecolorway or inherited from colorway) will be
extended to three times its original length by first
repeating every color 20% lighter then each color 20%
darker. This is intended to reduce the likelihood of
reusing the same color when you have many slices, but
you can set false to disable. Colors provided in the
trace, using marker.colors, are never extended.
extendsunburstcolors – If true, the sunburst slice colors (whether given by
sunburstcolorway or inherited from colorway) will
be extended to three times its original length by first
repeating every color 20% lighter then each color 20%
darker. This is intended to reduce the likelihood of
reusing the same color when you have many slices, but
you can set false to disable. Colors provided in the
trace, using marker.colors, are never extended.
extendtreemapcolors – If true, the treemap slice colors (whether given by
treemapcolorway or inherited from colorway) will be
extended to three times its original length by first
repeating every color 20% lighter then each color 20%
darker. This is intended to reduce the likelihood of
reusing the same color when you have many slices, but
you can set false to disable. Colors provided in the
trace, using marker.colors, are never extended.
font – Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
funnelareacolorway – Sets the default funnelarea slice colors. Defaults to
the main colorway used for trace colors. If you
specify a new list here it can still be extended with
lighter and darker colors, see
extendfunnelareacolors.
funnelgap – Sets the gap (in plot fraction) between bars of adjacent location coordinates.
funnelgroupgap – Sets the gap (in plot fraction) between bars of the same location coordinate.
funnelmode – 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 “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.
geo – plotly.graph_objects.layout.Geo instance or
dict with compatible properties
grid – plotly.graph_objects.layout.Grid instance or
dict with compatible properties
height – Sets the plot’s height (in px).
hiddenlabels – hiddenlabels is the funnelarea & pie chart analog of visible:’legendonly’ but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts
hiddenlabelssrc – Sets the source reference on Chart Studio Cloud for
hiddenlabels.
hidesources – Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on- premise).
hoverdistance – Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.
hoverlabel – plotly.graph_objects.layout.Hoverlabel
instance or dict with compatible properties
hovermode – Determines the mode of hover interactions. If
“closest”, a single hoverlabel will appear for the
“closest” point within the hoverdistance. If “x” (or
“y”), multiple hoverlabels will appear for multiple
points at the “closest” x- (or y-) coordinate within
the hoverdistance, with the caveat that no more than
one hoverlabel will appear per trace. If x unified
(or y unified), a single hoverlabel will appear
multiple points at the closest x- (or y-) coordinate
within the hoverdistance with the caveat that no more
than one hoverlabel will appear per trace. In this
mode, spikelines are enabled by default perpendicular
to the specified axis. If false, hover interactions are
disabled.
hoversubplots – Determines expansion of hover effects to other subplots
If “single” just the axis pair of the primary point is
included without overlaying subplots. If “overlaying”
all subplots using the main axis and occupying the same
space are included. If “axis”, also include stacked
subplots using the same axis when hovermode is set to
“x”, x unified, “y” or y unified.
iciclecolorway – Sets the default icicle slice colors. Defaults to the
main colorway used for trace colors. If you specify a
new list here it can still be extended with lighter and
darker colors, see extendiciclecolors.
images – A tuple of plotly.graph_objects.layout.Image
instances or dicts with compatible properties
imagedefaults – When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images
legend – plotly.graph_objects.layout.Legend instance or
dict with compatible properties
map – plotly.graph_objects.layout.Map instance or
dict with compatible properties
mapbox – plotly.graph_objects.layout.Mapbox instance or
dict with compatible properties
margin – plotly.graph_objects.layout.Margin instance or
dict with compatible properties
meta – Assigns extra meta information that can be used in
various text attributes. Attributes such as the
graph, axis and colorbar title.text, annotation
text trace.name in legend items, rangeselector,
updatemenus and sliders label text all support
meta. One can access meta fields using template
strings: %{meta[i]} where i is the index of the
meta item in question. meta can also be an object
for example {key: value} which can be accessed
%{meta[key]}.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
minreducedheight – Minimum height of the plot with margin.automargin applied (in px)
minreducedwidth – Minimum width of the plot with margin.automargin applied (in px)
modebar – plotly.graph_objects.layout.Modebar instance
or dict with compatible properties
newselection – plotly.graph_objects.layout.Newselection
instance or dict with compatible properties
newshape – plotly.graph_objects.layout.Newshape instance
or dict with compatible properties
paper_bgcolor – Sets the background color of the paper where the graph is drawn.
piecolorway – Sets the default pie slice colors. Defaults to the main
colorway used for trace colors. If you specify a new
list here it can still be extended with lighter and
darker colors, see extendpiecolors.
plot_bgcolor – Sets the background color of the plotting area in- between x and y axes.
polar – plotly.graph_objects.layout.Polar instance or
dict with compatible properties
scattergap – Sets the gap (in plot fraction) between scatter points
of adjacent location coordinates. Defaults to bargap.
scattermode – Determines how scatter points at the same location coordinate are displayed on the graph. With “group”, the scatter points are plotted next to one another centered around the shared location. With “overlay”, the scatter points are plotted over one another, you might need to reduce “opacity” to see multiple scatter points.
scene – plotly.graph_objects.layout.Scene instance or
dict with compatible properties
selectdirection – When dragmode is set to “select”, this limits the
selection of the drag to horizontal, vertical or
diagonal. “h” only allows horizontal selection, “v”
only vertical, “d” only diagonal and “any” sets no
limit.
selectionrevision – Controls persistence of user-driven changes in selected points from all traces.
selections – A tuple of
plotly.graph_objects.layout.Selection
instances or dicts with compatible properties
selectiondefaults – When used in a template (as layout.template.layout.selectiondefaults), sets the default property values to use for elements of layout.selections
separators – Sets the decimal and thousand separators. For example, *. * puts a ‘.’ before decimals and a space between thousands. In English locales, dflt is “.,” but other locales may alter this default.
shapes – A tuple of plotly.graph_objects.layout.Shape
instances or dicts with compatible properties
shapedefaults – When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes
showlegend – Determines whether or not a legend is drawn. Default is
true if there is a trace to show and any of these: a)
Two or more traces would by default be shown in the
legend. b) One pie trace is shown in the legend. c) One
trace is explicitly given with showlegend: true.
sliders – A tuple of plotly.graph_objects.layout.Slider
instances or dicts with compatible properties
sliderdefaults – When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders
smith – plotly.graph_objects.layout.Smith instance or
dict with compatible properties
spikedistance – Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.
sunburstcolorway – Sets the default sunburst slice colors. Defaults to the
main colorway used for trace colors. If you specify a
new list here it can still be extended with lighter and
darker colors, see extendsunburstcolors.
template – Default attributes to be applied to the plot. This
should be a dict with format: {'layout':
layoutTemplate, 'data': {trace_type: [traceTemplate,
...], ...}} where layoutTemplate is a dict matching
the structure of figure.layout and traceTemplate is
a dict matching the structure of the trace with type
trace_type (e.g. ‘scatter’). Alternatively, this may
be specified as an instance of
plotly.graph_objects.layout.Template. Trace templates are
applied cyclically to traces of each type. Container
arrays (eg annotations) have special handling: An
object ending in defaults (eg annotationdefaults)
is applied to each array item. But if an item has a
templateitemname key we look in the template array
for an item with matching name and apply that
instead. If no matching name is found we mark the
item invisible. Any named template item not referenced
is appended to the end of the array, so this can be
used to add a watermark annotation or a logo image, for
example. To omit one of these items on the plot, make
an item with matching templateitemname and visible:
false.
ternary – plotly.graph_objects.layout.Ternary instance
or dict with compatible properties
title – plotly.graph_objects.layout.Title instance or
dict with compatible properties
transition – Sets transition options used during Plotly.react updates.
treemapcolorway – Sets the default treemap slice colors. Defaults to the
main colorway used for trace colors. If you specify a
new list here it can still be extended with lighter and
darker colors, see extendtreemapcolors.
uirevision – Used to allow user interactions with the plot to
persist after Plotly.react calls that are unaware of
these interactions. If uirevision is omitted, or if
it is given and it changed from the previous
Plotly.react call, the exact new figure is used. If
uirevision is truthy and did NOT change, any
attribute that has been affected by user interactions
and did not receive a different value in the new figure
will keep the interaction value. layout.uirevision
attribute serves as the default for uirevision
attributes in various sub-containers. For finer control
you can set these sub-attributes directly. For example,
if your app separately controls the data on the x and y
axes you might set xaxis.uirevision=*time* and
yaxis.uirevision=*cost*. Then if only the y data is
changed, you can update yaxis.uirevision=*quantity*
and the y axis range will reset but the x axis range
will retain any user-driven zoom.
uniformtext – plotly.graph_objects.layout.Uniformtext
instance or dict with compatible properties
updatemenus – A tuple of
plotly.graph_objects.layout.Updatemenu
instances or dicts with compatible properties
updatemenudefaults – When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus
violingap – Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have “width” set.
violingroupgap – Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have “width” set.
violinmode – Determines how violins at the same location coordinate are displayed on the graph. If “group”, the violins are plotted next to one another centered around the shared location. If “overlay”, the violins are plotted over one another, you might need to set “opacity” to see them multiple violins. Has no effect on traces that have “width” set.
waterfallgap – Sets the gap (in plot fraction) between bars of adjacent location coordinates.
waterfallgroupgap – Sets the gap (in plot fraction) between bars of the same location coordinate.
waterfallmode – Determines how bars at the same location coordinate are displayed on the graph. With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.
width – Sets the plot’s width (in px).
xaxis – plotly.graph_objects.layout.XAxis instance or
dict with compatible properties
yaxis – plotly.graph_objects.layout.YAxis instance or
dict with compatible properties
plotly.graph_objects.layout¶plotly.graph_objects.layout.Activeselection(arg=None, fillcolor=None, opacity=None, **kwargs)¶fillcolor¶Sets the color filling the active selection’ interior.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
opacity¶Sets the opacity of the active selection.
An int or float in the interval [0, 1]
int|float
plotly.graph_objects.layout.Activeshape(arg=None, fillcolor=None, opacity=None, **kwargs)¶fillcolor¶Sets the color filling the active shape’ interior.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
opacity¶Sets the opacity of the active shape.
An int or float in the interval [0, 1]
int|float
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)¶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.
[‘left’, ‘center’, ‘right’]
Any
arrowcolor¶Sets the color of the annotation arrow.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
arrowhead¶Sets the end annotation arrow head style.
An int (or float that will be cast to an int) in the interval [0, 8]
arrowside¶Sets the annotation arrow head position.
The ‘arrowside’ property is a flaglist and may be specified as a string containing:
Any combination of [‘end’, ‘start’] joined with ‘+’ characters (e.g. ‘end+start’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
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.
An int or float in the interval [0.3, inf]
int|float
arrowwidth¶Sets the width (in px) of annotation arrow line.
An int or float in the interval [0.1, inf]
int|float
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
Any
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.
[‘pixel’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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
Any
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.
[‘pixel’]
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
bgcolor¶Sets the background color of the annotation.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
bordercolor¶Sets the color of the border enclosing the annotation text.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
borderpad¶Sets the padding (in px) between the text and the enclosing
border.
An int or float in the interval [0, inf]
int|float
borderwidth¶Sets the width (in px) of the border enclosing the annotation
text.
An int or float in the interval [0, inf]
int|float
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 must be specified as a bool (either True, or False)
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.
[False, ‘onoff’, ‘onout’]
Any
font¶Sets the annotation text font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.annotation.FontA dict of string/value properties that will be passed to the Font constructor
height¶Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.
An int or float in the interval [1, inf]
int|float
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.layout.annotation.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
hovertext¶Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.
A string
A number that will be converted to a string
name¶When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname matching this
name alongside your modifications (including visible: false
or enabled: false to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the annotation (text + arrow).
An int or float in the interval [0, 1]
int|float
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 must be specified as a bool (either True, or False)
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.
An int or float in the interval [0, inf]
int|float
startarrowhead¶Sets the start annotation arrow head style.
An int (or float that will be cast to an int) in the interval [0, 8]
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.
An int or float in the interval [0.3, inf]
int|float
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.
An int or float in the interval [0, inf]
int|float
templateitemname¶Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname matching its name,
alongside your modifications (including visible: false or
enabled: false to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true.
A string
A number that will be converted to a string
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> <span> are also supported.
A string
A number that will be converted to a string
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).
int|float
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.
[‘top’, ‘middle’, ‘bottom’]
Any
visible¶Determines whether or not this annotation is visible.
The ‘visible’ property must be specified as a bool (either True, or False)
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.
An int or float in the interval [1, inf]
int|float
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
Any
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.
[‘auto’, ‘left’, ‘center’, ‘right’]
Any
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
Any
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.
[‘paper’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
xshift¶Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.
An int or float
int|float
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
Any
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.
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
Any
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
Any
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.
[‘paper’]
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
yshift¶Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
An int or float
int|float
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)¶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 must be specified as a bool (either True, or False)
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 must be specified as a bool (either True, or False)
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.
An int or float
int|float
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.
An int or float
int|float
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.
An int or float
int|float
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.layout.coloraxis.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
colorscale¶Sets the colorscale. The colorscale must be an array containing
arrays mapping a normalized value to an rgb, rgba, hex, hsl,
hsv, 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.
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 must be specified as a bool (either True, or False)
plotly.graph_objects.layout.Colorscale(arg=None, diverging=None, sequential=None, sequentialminus=None, **kwargs)¶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.
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.
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.
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)¶color¶A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
A non-empty string
lineposition¶Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
shadow¶Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
A string
A number that will be converted to a string
size¶An int or float in the interval [1, inf]
int|float
style¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
Any
textcase¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
Any
variant¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
Any
plotly.graph_objects.layout.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)¶bgcolor¶Set the background color of the map
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
center¶The ‘center’ property is an instance of Center that may be specified as:
An instance of
plotly.graph_objects.layout.geo.CenterA dict of string/value properties that will be passed to the Center constructor
coastlinecolor¶Sets the coastline color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
coastlinewidth¶Sets the coastline stroke width (in px).
An int or float in the interval [0, inf]
int|float
countrycolor¶Sets line color of the country boundaries.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
countrywidth¶Sets line width (in px) of the country boundaries.
An int or float in the interval [0, inf]
int|float
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.geo.DomainA dict of string/value properties that will be passed to the Domain constructor
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”, 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, Defaults to False.
[False, ‘locations’, ‘geojson’]
Any
framecolor¶Sets the color the frame.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
framewidth¶Sets the stroke width (in px) of the frame.
An int or float in the interval [0, inf]
int|float
lakecolor¶Sets the color of the lakes.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
landcolor¶Sets the land mass color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
lataxis¶The ‘lataxis’ property is an instance of Lataxis that may be specified as:
An instance of
plotly.graph_objects.layout.geo.LataxisA dict of string/value properties that will be passed to the Lataxis constructor
lonaxis¶The ‘lonaxis’ property is an instance of Lonaxis that may be specified as:
An instance of
plotly.graph_objects.layout.geo.LonaxisA dict of string/value properties that will be passed to the Lonaxis constructor
oceancolor¶Sets the ocean color
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
projection¶The ‘projection’ property is an instance of Projection that may be specified as:
An instance of
plotly.graph_objects.layout.geo.ProjectionA dict of string/value properties that will be passed to the Projection constructor
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.
[110, 50]
Any
rivercolor¶Sets color of the rivers.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
riverwidth¶Sets the stroke width (in px) of the rivers.
An int or float in the interval [0, inf]
int|float
scope¶Set the scope of the map.
[‘africa’, ‘asia’, ‘europe’, ‘north america’, ‘south america’, ‘usa’, ‘world’]
Any
showcoastlines¶Sets whether or not the coastlines are drawn.
The ‘showcoastlines’ property must be specified as a bool (either True, or False)
showcountries¶Sets whether or not country boundaries are drawn.
The ‘showcountries’ property must be specified as a bool (either True, or False)
showframe¶Sets whether or not a frame is drawn around the map.
The ‘showframe’ property must be specified as a bool (either True, or False)
showlakes¶Sets whether or not lakes are drawn.
The ‘showlakes’ property must be specified as a bool (either True, or False)
showland¶Sets whether or not land masses are filled in color.
The ‘showland’ property must be specified as a bool (either True, or False)
showocean¶Sets whether or not oceans are filled in color.
The ‘showocean’ property must be specified as a bool (either True, or False)
showrivers¶Sets whether or not rivers are drawn.
The ‘showrivers’ property must be specified as a bool (either True, or False)
showsubunits¶Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
The ‘showsubunits’ property must be specified as a bool (either True, or False)
subunitcolor¶Sets the color of the subunits boundaries.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
subunitwidth¶Sets the stroke width (in px) of the subunits boundaries.
An int or float in the interval [0, inf]
int|float
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
Any
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)¶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.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.grid.DomainA dict of string/value properties that will be passed to the Domain constructor
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.
[‘independent’, ‘coupled’]
Any
roworder¶Is the first row the top or the bottom? Note that columns are always enumerated from left to right.
[‘top to bottom’, ‘bottom to top’]
Any
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.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
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]+)?$’]
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)?$’]
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.
An int or float in the interval [0, 1]
int|float
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.
[‘bottom’, ‘bottom plot’, ‘top plot’, ‘top’]
Any
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)?$’]
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.
An int or float in the interval [0, 1]
int|float
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.
[‘left’, ‘left plot’, ‘right plot’, ‘right’]
Any
plotly.graph_objects.layout.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, grouptitlefont=None, namelength=None, **kwargs)¶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
[‘left’, ‘right’, ‘auto’]
Any
bgcolor¶Sets the background color of all hover labels on graph
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
bordercolor¶Sets the border color of all hover labels on graph.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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:
An instance of
plotly.graph_objects.layout.hoverlabel.FontA dict of string/value properties that will be passed to the Font constructor
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:
An instance of
plotly.graph_objects.layout.hoverlabel.GrouptitlefontA dict of string/value properties that will be passed to the Grouptitlefont constructor
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.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
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)¶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.
[‘below’, ‘above’]
Any
name¶When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname matching this
name alongside your modifications (including visible: false
or enabled: false to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the image.
An int or float in the interval [0, 1]
int|float
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.
An int or float
int|float
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.
An int or float
int|float
sizing¶Specifies which dimension of the image to constrain.
[‘fill’, ‘contain’, ‘stretch’]
Any
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.
A remote image URI string (e.g. ‘http://www.somewhere.com/image.png’)
A data URI image string (e.g. ‘data:image/png;base64,iVBORw0KGgoAAAANSU’)
A PIL.Image.Image object which will be immediately converted to a data URI image string See http://pillow.readthedocs.io/en/latest/reference/Image.html
templateitemname¶Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname matching its name,
alongside your modifications (including visible: false or
enabled: false to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true.
A string
A number that will be converted to a string
visible¶Determines whether or not this image is visible.
The ‘visible’ property must be specified as a bool (either True, or False)
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
Any
xanchor¶Sets the anchor for the x position
[‘left’, ‘center’, ‘right’]
Any
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.
[‘paper’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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
Any
yanchor¶Sets the anchor for the y position.
[‘top’, ‘middle’, ‘bottom’]
Any
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.
[‘paper’]
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
plotly.graph_objects.layout.Legend(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, entrywidth=None, entrywidthmode=None, font=None, groupclick=None, grouptitlefont=None, indentation=None, itemclick=None, itemdoubleclick=None, itemsizing=None, itemwidth=None, orientation=None, title=None, tracegroupgap=None, traceorder=None, uirevision=None, valign=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, **kwargs)¶bgcolor¶Sets the legend background color. Defaults to
layout.paper_bgcolor.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
bordercolor¶Sets the color of the border enclosing the legend.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
borderwidth¶Sets the width (in px) of the border enclosing the legend.
An int or float in the interval [0, inf]
int|float
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”.
An int or float in the interval [0, inf]
int|float
entrywidthmode¶Determines what entrywidth means.
[‘fraction’, ‘pixels’]
Any
font¶Sets the font used to text the legend items.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.legend.FontA dict of string/value properties that will be passed to the Font constructor
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.
[‘toggleitem’, ‘togglegroup’]
Any
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:
An instance of
plotly.graph_objects.layout.legend.GrouptitlefontA dict of string/value properties that will be passed to the Grouptitlefont constructor
indentation¶Sets the indentation (in px) of the legend entries.
An int or float in the interval [-15, inf]
int|float
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.
[‘toggle’, ‘toggleothers’, False]
Any
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.
[‘toggle’, ‘toggleothers’, False]
Any
itemsizing¶Determines if the legend items symbols scale with their corresponding “trace” attributes or remain “constant” independent of the symbol size on the graph.
[‘trace’, ‘constant’]
Any
itemwidth¶Sets the width (in px) of the legend item symbols (the part other than the title.text).
An int or float in the interval [30, inf]
int|float
orientation¶Sets the orientation of the legend.
[‘v’, ‘h’]
Any
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.layout.legend.TitleA dict of string/value properties that will be passed to the Title constructor
tracegroupgap¶Sets the amount of vertical space (in px) between legend groups.
An int or float in the interval [0, inf]
int|float
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:
Any combination of [‘reversed’, ‘grouped’] joined with ‘+’ characters (e.g. ‘reversed+grouped’) OR exactly one of [‘normal’] (e.g. ‘normal’)
Any
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
Any
valign¶Sets the vertical alignment of the symbols with respect to their associated text.
[‘top’, ‘middle’, ‘bottom’]
Any
visible¶Determines whether or not this legend is visible.
The ‘visible’ property must be specified as a bool (either True, or False)
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”.
An int or float
int|float
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.
[‘auto’, ‘left’, ‘center’, ‘right’]
Any
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.
[‘container’, ‘paper’]
Any
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”.
An int or float
int|float
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.
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
Any
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.
[‘container’, ‘paper’]
Any
plotly.graph_objects.layout.Map(arg=None, bearing=None, bounds=None, center=None, domain=None, layers=None, layerdefaults=None, pitch=None, style=None, uirevision=None, zoom=None, **kwargs)¶bearing¶Sets the bearing angle of the map in degrees counter-clockwise from North (map.bearing).
An int or float
int|float
bounds¶The ‘bounds’ property is an instance of Bounds that may be specified as:
An instance of
plotly.graph_objects.layout.map.BoundsA dict of string/value properties that will be passed to the Bounds constructor
center¶The ‘center’ property is an instance of Center that may be specified as:
An instance of
plotly.graph_objects.layout.map.CenterA dict of string/value properties that will be passed to the Center constructor
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.map.DomainA dict of string/value properties that will be passed to the Domain constructor
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:
An instance of
plotly.graph_objects.layout.map.LayerA dict of string/value properties that will be passed to the Layer constructor
layers¶The ‘layers’ property is a tuple of instances of Layer that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.map.Layer
A list or tuple of dicts of string/value properties that will be passed to the Layer constructor
pitch¶Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (map.pitch).
An int or float
int|float
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
Any
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
Any
zoom¶Sets the zoom level of the map (map.zoom).
An int or float
int|float
plotly.graph_objects.layout.Mapbox(arg=None, accesstoken=None, bearing=None, bounds=None, center=None, domain=None, layers=None, layerdefaults=None, pitch=None, style=None, uirevision=None, zoom=None, **kwargs)¶accesstoken¶Sets the mapbox access token to be used for this mapbox map.
Alternatively, the mapbox access token can be set in the
configuration options under mapboxAccessToken. Note that
accessToken are only required when style (e.g with values :
basic, streets, outdoors, light, dark, satellite, satellite-
streets ) and/or a layout layer references the Mapbox server.
A non-empty string
bearing¶Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).
An int or float
int|float
bounds¶The ‘bounds’ property is an instance of Bounds that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.BoundsA dict of string/value properties that will be passed to the Bounds constructor
center¶The ‘center’ property is an instance of Center that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.CenterA dict of string/value properties that will be passed to the Center constructor
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.DomainA dict of string/value properties that will be passed to the Domain constructor
layerdefaults¶When used in a template (as layout.template.layout.mapbox.layerdefaults), sets the default property values to use for elements of layout.mapbox.layers
The ‘layerdefaults’ property is an instance of Layer that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.LayerA dict of string/value properties that will be passed to the Layer constructor
layers¶The ‘layers’ property is a tuple of instances of Layer that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.mapbox.Layer
A list or tuple of dicts of string/value properties that will be passed to the Layer constructor
pitch¶Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).
An int or float
int|float
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.mapbox.layers.
These layers can be defined either explicitly as a Mapbox 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 which do not require any
access tokens, or by using a default Mapbox style or custom
Mapbox style URL, both of which require a Mapbox access token
Note that Mapbox access token can be set in the accesstoken
attribute or in the mapboxAccessToken config option. Mapbox
Style objects are of the form described in the Mapbox GL JS
documentation available at https://docs.mapbox.com/mapbox-gl-
js/style-spec The built-in plotly.js styles objects are:
carto-darkmatter, carto-positron, open-street-map, stamen-
terrain, stamen-toner, stamen-watercolor, white-bg The built-
in Mapbox styles are: basic, streets, outdoors, light, dark,
satellite, satellite-streets Mapbox style URLs are of the
form: mapbox://mapbox.mapbox-<name>-<version>
The ‘style’ property accepts values of any type
Any
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
Any
zoom¶Sets the zoom level of the map (mapbox.zoom).
An int or float
int|float
plotly.graph_objects.layout.Margin(arg=None, autoexpand=None, b=None, l=None, pad=None, r=None, t=None, **kwargs)¶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 must be specified as a bool (either True, or False)
b¶Sets the bottom margin (in px).
An int or float in the interval [0, inf]
int|float
l¶Sets the left margin (in px).
An int or float in the interval [0, inf]
int|float
pad¶Sets the amount of padding (in px) between the plotting area and the axis lines
An int or float in the interval [0, inf]
int|float
r¶Sets the right margin (in px).
An int or float in the interval [0, inf]
int|float
t¶Sets the top margin (in px).
An int or float in the interval [0, inf]
int|float
plotly.graph_objects.layout.Modebar(arg=None, activecolor=None, add=None, addsrc=None, bgcolor=None, color=None, orientation=None, remove=None, removesrc=None, uirevision=None, **kwargs)¶activecolor¶Sets the color of the active or hovered on icons in the modebar.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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”.
A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
addsrc¶Sets the source reference on Chart Studio Cloud for add.
The ‘addsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
bgcolor¶Sets the background color of the modebar.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
color¶Sets the color of the icons in the modebar.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
orientation¶Sets the orientation of the modebar.
[‘v’, ‘h’]
Any
remove¶Determines which predefined modebar buttons to remove. Similar
to config.modeBarButtonsToRemove option. This may include
“autoScale2d”, “autoscale”, “editInChartStudio”,
“editinchartstudio”, “hoverCompareCartesian”, “hovercompare”,
“lasso”, “lasso2d”, “orbitRotation”, “orbitrotation”, “pan”,
“pan2d”, “pan3d”, “reset”, “resetCameraDefault3d”,
“resetCameraLastSave3d”, “resetGeo”, “resetSankeyGroup”,
“resetScale2d”, “resetViewMap”, “resetViewMapbox”,
“resetViews”, “resetcameradefault”, “resetcameralastsave”,
“resetsankeygroup”, “resetscale”, “resetview”, “resetviews”,
“select”, “select2d”, “sendDataToCloud”, “senddatatocloud”,
“tableRotation”, “tablerotation”, “toImage”, “toggleHover”,
“toggleSpikelines”, “togglehover”, “togglespikelines”,
“toimage”, “zoom”, “zoom2d”, “zoom3d”, “zoomIn2d”, “zoomInGeo”,
“zoomInMap”, “zoomInMapbox”, “zoomOut2d”, “zoomOutGeo”,
“zoomOutMap”, “zoomOutMapbox”, “zoomin”, “zoomout”.
A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
removesrc¶Sets the source reference on Chart Studio Cloud for remove.
The ‘removesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
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
Any
plotly.graph_objects.layout.Newselection(arg=None, line=None, mode=None, **kwargs)¶line¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.layout.newselection.LineA dict of string/value properties that will be passed to the Line constructor
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.
[‘immediate’, ‘gradual’]
Any
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)¶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.
[‘ortho’, ‘horizontal’, ‘vertical’, ‘diagonal’]
Any
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.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
fillrule¶Determines the path’s interior. For more info please visit https://developer.mozilla.org/en- US/docs/Web/SVG/Attribute/fill-rule
[‘evenodd’, ‘nonzero’]
Any
label¶The ‘label’ property is an instance of Label that may be specified as:
An instance of
plotly.graph_objects.layout.newshape.LabelA dict of string/value properties that will be passed to the Label constructor
layer¶Specifies whether new shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).
[‘below’, ‘above’, ‘between’]
Any
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.)
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.
A string
A number that will be converted to a string
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.layout.newshape.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
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.
An int or float
int|float
legendwidth¶Sets the width (in px or fraction) of the legend for new shape.
An int or float in the interval [0, inf]
int|float
line¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.layout.newshape.LineA dict of string/value properties that will be passed to the Line constructor
name¶Sets new shape name. The name appears as the legend item.
A string
A number that will be converted to a string
opacity¶Sets the opacity of new shapes.
An int or float in the interval [0, 1]
int|float
showlegend¶Determines whether or not new shape is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
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).
[True, False, ‘legendonly’]
Any
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)¶angularaxis¶The ‘angularaxis’ property is an instance of AngularAxis that may be specified as:
An instance of
plotly.graph_objects.layout.polar.AngularAxisA dict of string/value properties that will be passed to the AngularAxis constructor
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.
An int or float in the interval [0, 1]
int|float
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.
[‘stack’, ‘overlay’]
Any
bgcolor¶Set the background color of the subplot
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.polar.DomainA dict of string/value properties that will be passed to the Domain constructor
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).
[‘circular’, ‘linear’]
Any
hole¶Sets the fraction of the radius to cut out of the polar subplot.
An int or float in the interval [0, 1]
int|float
radialaxis¶The ‘radialaxis’ property is an instance of RadialAxis that may be specified as:
An instance of
plotly.graph_objects.layout.polar.RadialAxisA dict of string/value properties that will be passed to the RadialAxis constructor
sector¶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:
a list or tuple of 2 elements where:
An int or float
An int or float
list
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
Any
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)¶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:
An instance of
plotly.graph_objects.layout.scene.AnnotationA dict of string/value properties that will be passed to the Annotation constructor
annotations¶The ‘annotations’ property is a tuple of instances of Annotation that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.scene.Annotation
A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor
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.
[‘auto’, ‘cube’, ‘data’, ‘manual’]
Any
aspectratio¶Sets this scene’s axis aspectratio.
The ‘aspectratio’ property is an instance of Aspectratio that may be specified as:
An instance of
plotly.graph_objects.layout.scene.AspectratioA dict of string/value properties that will be passed to the Aspectratio constructor
bgcolor¶A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
camera¶The ‘camera’ property is an instance of Camera that may be specified as:
An instance of
plotly.graph_objects.layout.scene.CameraA dict of string/value properties that will be passed to the Camera constructor
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.scene.DomainA dict of string/value properties that will be passed to the Domain constructor
dragmode¶Determines the mode of drag interactions for this scene.
[‘orbit’, ‘turntable’, ‘zoom’, ‘pan’, False]
Any
hovermode¶Determines the mode of hover interactions for this scene.
[‘closest’, False]
Any
uirevision¶Controls persistence of user-driven changes in camera
attributes. Defaults to layout.uirevision.
The ‘uirevision’ property accepts values of any type
Any
xaxis¶The ‘xaxis’ property is an instance of XAxis that may be specified as:
An instance of
plotly.graph_objects.layout.scene.XAxisA dict of string/value properties that will be passed to the XAxis constructor
yaxis¶The ‘yaxis’ property is an instance of YAxis that may be specified as:
An instance of
plotly.graph_objects.layout.scene.YAxisA dict of string/value properties that will be passed to the YAxis constructor
zaxis¶The ‘zaxis’ property is an instance of ZAxis that may be specified as:
An instance of
plotly.graph_objects.layout.scene.ZAxisA dict of string/value properties that will be passed to the ZAxis constructor
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)¶line¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.layout.selection.LineA dict of string/value properties that will be passed to the Line constructor
name¶When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname matching this
name alongside your modifications (including visible: false
or enabled: false to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the selection.
An int or float in the interval [0, 1]
int|float
path¶For type “path” - a valid SVG path similar to shapes.path
in data coordinates. Allowed segments are: M, L and Z.
A string
A number that will be converted to a string
templateitemname¶Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname matching its name,
alongside your modifications (including visible: false or
enabled: false to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true.
A string
A number that will be converted to a string
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.
[‘rect’, ‘path’]
Any
x0¶Sets the selection’s starting x position.
The ‘x0’ property accepts values of any type
Any
x1¶Sets the selection’s end x position.
The ‘x1’ property accepts values of any type
Any
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.
[‘paper’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
y0¶Sets the selection’s starting y position.
The ‘y0’ property accepts values of any type
Any
y1¶Sets the selection’s end y position.
The ‘y1’ property accepts values of any type
Any
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.
[‘paper’]
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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)¶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 must be specified as a bool (either True, or False)
fillcolor¶Sets the color filling the shape’s interior. Only applies to closed shapes.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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
[‘evenodd’, ‘nonzero’]
Any
label¶The ‘label’ property is an instance of Label that may be specified as:
An instance of
plotly.graph_objects.layout.shape.LabelA dict of string/value properties that will be passed to the Label constructor
layer¶Specifies whether shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).
[‘below’, ‘above’, ‘between’]
Any
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.)
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.
A string
A number that will be converted to a string
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.layout.shape.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
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.
An int or float
int|float
legendwidth¶Sets the width (in px or fraction) of the legend for this shape.
An int or float in the interval [0, inf]
int|float
line¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.layout.shape.LineA dict of string/value properties that will be passed to the Line constructor
name¶When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname matching this
name alongside your modifications (including visible: false
or enabled: false to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the shape.
An int or float in the interval [0, 1]
int|float
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
A string
A number that will be converted to a string
showlegend¶Determines whether or not this shape is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
templateitemname¶Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname matching its name,
alongside your modifications (including visible: false or
enabled: false to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true.
A string
A number that will be converted to a string
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.
[‘circle’, ‘rect’, ‘path’, ‘line’]
Any
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).
[True, False, ‘legendonly’]
Any
x0¶Sets the shape’s starting x position. See type and
xsizemode for more info.
The ‘x0’ property accepts values of any type
Any
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.
An int or float in the interval [-1, 1]
int|float
x1¶Sets the shape’s end x position. See type and xsizemode for
more info.
The ‘x1’ property accepts values of any type
Any
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.
An int or float in the interval [-1, 1]
int|float
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
Any
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.
[‘paper’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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.
[‘scaled’, ‘pixel’]
Any
y0¶Sets the shape’s starting y position. See type and
ysizemode for more info.
The ‘y0’ property accepts values of any type
Any
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.
An int or float in the interval [-1, 1]
int|float
y1¶Sets the shape’s end y position. See type and ysizemode for
more info.
The ‘y1’ property accepts values of any type
Any
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.
An int or float in the interval [-1, 1]
int|float
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
Any
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.
[‘paper’]
[‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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.
[‘scaled’, ‘pixel’]
Any
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)¶active¶Determines which button (by index starting from 0) is considered active.
An int or float in the interval [0, inf]
int|float
activebgcolor¶Sets the background color of the slider grip while dragging.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
bgcolor¶Sets the background color of the slider.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
bordercolor¶Sets the color of the border enclosing the slider.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
borderwidth¶Sets the width (in px) of the border enclosing the slider.
An int or float in the interval [0, inf]
int|float
currentvalue¶The ‘currentvalue’ property is an instance of Currentvalue that may be specified as:
An instance of
plotly.graph_objects.layout.slider.CurrentvalueA dict of string/value properties that will be passed to the Currentvalue constructor
font¶Sets the font of the slider step labels.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.slider.FontA dict of string/value properties that will be passed to the Font constructor
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.
An int or float in the interval [0, inf]
int|float
lenmode¶Determines whether this slider length is set in units of plot
“fraction” or in *pixels. Use len to set the value.
[‘fraction’, ‘pixels’]
Any
minorticklen¶Sets the length in pixels of minor step tick marks
An int or float in the interval [0, inf]
int|float
name¶When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname matching this
name alongside your modifications (including visible: false
or enabled: false to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
pad¶Set the padding of the slider component along each side.
The ‘pad’ property is an instance of Pad that may be specified as:
An instance of
plotly.graph_objects.layout.slider.PadA dict of string/value properties that will be passed to the Pad constructor
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:
An instance of
plotly.graph_objects.layout.slider.StepA dict of string/value properties that will be passed to the Step constructor
steps¶The ‘steps’ property is a tuple of instances of Step that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.slider.Step
A list or tuple of dicts of string/value properties that will be passed to the Step constructor
templateitemname¶Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname matching its name,
alongside your modifications (including visible: false or
enabled: false to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true.
A string
A number that will be converted to a string
tickcolor¶Sets the color of the border enclosing the slider.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
ticklen¶Sets the length in pixels of step tick marks
An int or float in the interval [0, inf]
int|float
tickwidth¶Sets the tick width (in px).
An int or float in the interval [0, inf]
int|float
transition¶The ‘transition’ property is an instance of Transition that may be specified as:
An instance of
plotly.graph_objects.layout.slider.TransitionA dict of string/value properties that will be passed to the Transition constructor
visible¶Determines whether or not the slider is visible.
The ‘visible’ property must be specified as a bool (either True, or False)
x¶Sets the x position (in normalized coordinates) of the slider.
An int or float in the interval [-2, 3]
int|float
xanchor¶Sets the slider’s horizontal position anchor. This anchor binds
the x position to the “left”, “center” or “right” of the
range selector.
[‘auto’, ‘left’, ‘center’, ‘right’]
Any
y¶Sets the y position (in normalized coordinates) of the slider.
An int or float in the interval [-2, 3]
int|float
yanchor¶Sets the slider’s vertical position anchor This anchor binds
the y position to the “top”, “middle” or “bottom” of the
range selector.
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
Any
plotly.graph_objects.layout.Smith(arg=None, bgcolor=None, domain=None, imaginaryaxis=None, realaxis=None, **kwargs)¶bgcolor¶Set the background color of the subplot
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.smith.DomainA dict of string/value properties that will be passed to the Domain constructor
imaginaryaxis¶The ‘imaginaryaxis’ property is an instance of Imaginaryaxis that may be specified as:
An instance of
plotly.graph_objects.layout.smith.ImaginaryaxisA dict of string/value properties that will be passed to the Imaginaryaxis constructor
realaxis¶The ‘realaxis’ property is an instance of Realaxis that may be specified as:
An instance of
plotly.graph_objects.layout.smith.RealaxisA dict of string/value properties that will be passed to the Realaxis constructor
plotly.graph_objects.layout.Template(arg=None, data=None, layout=None, **kwargs)¶data¶The ‘data’ property is an instance of Data that may be specified as:
An instance of
plotly.graph_objects.layout.template.DataA dict of string/value properties that will be passed to the Data constructor
layout¶The ‘layout’ property is an instance of Layout that may be specified as:
An instance of
plotly.graph_objects.LayoutA dict of string/value properties that will be passed to the Layout constructor
plotly.graph_objects.layout.Ternary(arg=None, aaxis=None, baxis=None, bgcolor=None, caxis=None, domain=None, sum=None, uirevision=None, **kwargs)¶aaxis¶The ‘aaxis’ property is an instance of Aaxis that may be specified as:
An instance of
plotly.graph_objects.layout.ternary.AaxisA dict of string/value properties that will be passed to the Aaxis constructor
baxis¶The ‘baxis’ property is an instance of Baxis that may be specified as:
An instance of
plotly.graph_objects.layout.ternary.BaxisA dict of string/value properties that will be passed to the Baxis constructor
bgcolor¶Set the background color of the subplot
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
caxis¶The ‘caxis’ property is an instance of Caxis that may be specified as:
An instance of
plotly.graph_objects.layout.ternary.CaxisA dict of string/value properties that will be passed to the Caxis constructor
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.layout.ternary.DomainA dict of string/value properties that will be passed to the Domain constructor
sum¶The number each triplet should sum to, and the maximum range of each axis
An int or float in the interval [0, inf]
int|float
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
Any
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)¶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 must be specified as a bool (either True, or False)
font¶Sets the title font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.title.FontA dict of string/value properties that will be passed to the Font constructor
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:
An instance of
plotly.graph_objects.layout.title.PadA dict of string/value properties that will be passed to the Pad constructor
subtitle¶The ‘subtitle’ property is an instance of Subtitle that may be specified as:
An instance of
plotly.graph_objects.layout.title.SubtitleA dict of string/value properties that will be passed to the Subtitle constructor
text¶Sets the plot’s title.
A string
A number that will be converted to a string
x¶Sets the x position with respect to xref in normalized
coordinates from 0 (left) to 1 (right).
An int or float in the interval [0, 1]
int|float
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.
[‘auto’, ‘left’, ‘center’, ‘right’]
Any
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.
[‘container’, ‘paper’]
Any
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.
An int or float in the interval [0, 1]
int|float
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.
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
Any
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.
[‘container’, ‘paper’]
Any
plotly.graph_objects.layout.Transition(arg=None, duration=None, easing=None, ordering=None, **kwargs)¶duration¶The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.
An int or float in the interval [0, inf]
int|float
easing¶The easing function used for the transition
[‘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’]
Any
ordering¶Determines whether the figure’s layout or traces smoothly transitions during updates that make both traces and layout change.
[‘layout first’, ‘traces first’]
Any
plotly.graph_objects.layout.Uniformtext(arg=None, minsize=None, mode=None, **kwargs)¶minsize¶Sets the minimum text size between traces of the same type.
An int or float in the interval [0, inf]
int|float
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.
[False, ‘hide’, ‘show’]
Any
Determines which button (by index starting from 0) is considered active.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
Sets the background color of the update menu buttons.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
Sets the color of the border enclosing the update menu.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
Sets the width (in px) of the border enclosing the update menu.
An int or float in the interval [0, inf]
int|float
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:
An instance of
plotly.graph_objects.layout.updatemenu.ButtonA dict of string/value properties that will be passed to the Button constructor
The ‘buttons’ property is a tuple of instances of Button that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.updatemenu.Button
A list or tuple of dicts of string/value properties that will be passed to the Button constructor
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.
[‘left’, ‘right’, ‘up’, ‘down’]
Any
Sets the font of the update menu button text.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.updatemenu.FontA dict of string/value properties that will be passed to the Font constructor
When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname matching this
name alongside your modifications (including visible: false
or enabled: false to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
Sets the padding around the buttons or dropdown menu.
The ‘pad’ property is an instance of Pad that may be specified as:
An instance of
plotly.graph_objects.layout.updatemenu.PadA dict of string/value properties that will be passed to the Pad constructor
Highlights active dropdown item or active button if true.
The ‘showactive’ property must be specified as a bool (either True, or False)
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname matching its name,
alongside your modifications (including visible: false or
enabled: false to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true.
A string
A number that will be converted to a string
Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically
[‘dropdown’, ‘buttons’]
Any
Determines whether or not the update menu is visible.
The ‘visible’ property must be specified as a bool (either True, or False)
Sets the x position (in normalized coordinates) of the update menu.
An int or float in the interval [-2, 3]
int|float
Sets the update menu’s horizontal position anchor. This anchor
binds the x position to the “left”, “center” or “right” of
the range selector.
[‘auto’, ‘left’, ‘center’, ‘right’]
Any
Sets the y position (in normalized coordinates) of the update menu.
An int or float in the interval [-2, 3]
int|float
Sets the update menu’s vertical position anchor This anchor
binds the y position to the “top”, “middle” or “bottom” of
the range selector.
[‘auto’, ‘top’, ‘middle’, ‘bottom’]
Any
plotly.graph_objects.layout.XAxis(arg=None, anchor=None, automargin=None, autorange=None, autorangeoptions=None, autotickangles=None, autotypenumbers=None, calendar=None, categoryarray=None, categoryarraysrc=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, mirror=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, ticklabelindexsrc=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, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, type=None, uirevision=None, visible=None, zeroline=None, zerolinecolor=None, zerolinewidth=None, **kwargs)¶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.
[‘free’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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’)
Any
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.
[True, False, ‘reversed’, ‘min reversed’, ‘max reversed’, ‘min’, ‘max’]
Any
autorangeoptions¶The ‘autorangeoptions’ property is an instance of Autorangeoptions that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.AutorangeoptionsA dict of string/value properties that will be passed to the Autorangeoptions constructor
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).
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.
[‘convert types’, ‘strict’]
Any
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
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
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
numpy.ndarray
categoryarraysrc¶Sets the source reference on Chart Studio Cloud for
categoryarray.
The ‘categoryarraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
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.
[‘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’]
Any
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.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
[‘range’, ‘domain’]
Any
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.
[‘left’, ‘center’, ‘right’, ‘top’, ‘middle’, ‘bottom’]
Any
dividercolor¶Sets the color of the dividers Only has an effect on “multicategory” axes.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
dividerwidth¶Sets the width (in px) of the dividers Only has an effect on “multicategory” axes.
An int or float
int|float
domain¶Sets the domain of this axis (in plot fraction).
The ‘domain’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
An int or float in the interval [0, 1]
An int or float in the interval [0, 1]
list
dtick¶Sets the step in-between ticks on this axis. Use with tick0.
Must be a positive number, or special strings available to
“log” and “date” axes. If the axis type is “log”, then ticks
are set every 10^(n*dtick) where n is the tick number. For
example, to set a tick mark at 1, 10, 100, 1000, … set dtick
to 1. To set tick marks at 1, 100, 10000, … set dtick to 2.
To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to
log_10(5), or 0.69897000433. “log” has several special values;
“L<f>”, where f is a positive number, gives ticks linearly
spaced in value (but not position). For example tick0 = 0.1,
dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To
show powers of 10 plus small digits between, use “D1” (all
digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and
“D2”. If the axis type is “date”, then you must convert the
time to milliseconds. For example, to set the interval between
ticks to one day, set dtick to 86400000.0. “date” also has
special values “M<n>” gives ticks spaced by a number of months.
n must be a positive integer. To set ticks on the 15th of
every third month, set tick0 to “2000-01-15” and dtick to
“M3”. To set ticks every 4 years, set dtick to “M48”
The ‘dtick’ property accepts values of any type
Any
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.
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]
Any
fixedrange¶Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
The ‘fixedrange’ property must be specified as a bool (either True, or False)
gridcolor¶Sets the color of the grid lines.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
griddash¶Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
gridwidth¶Sets the width (in px) of the grid lines.
An int or float in the interval [0, inf]
int|float
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”
A string
A number that will be converted to a string
insiderange¶(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:
a list or tuple of 2 elements where:
The ‘insiderange[0]’ property accepts values of any type
The ‘insiderange[1]’ property accepts values of any type
list
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
Any
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.
[‘above traces’, ‘below traces’]
Any
linecolor¶Sets the axis line color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
linewidth¶Sets the width (in px) of the axis line.
An int or float in the interval [0, inf]
int|float
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.
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
maxallowed¶Determines the maximum range of this axis.
The ‘maxallowed’ property accepts values of any type
Any
minallowed¶Determines the minimum range of this axis.
The ‘minallowed’ property accepts values of any type
Any
minexponent¶Hide SI prefix for 10^n if |n| is below this number. This only
has an effect when tickformat is “SI” or “B”.
An int or float in the interval [0, inf]
int|float
minor¶The ‘minor’ property is an instance of Minor that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.MinorA dict of string/value properties that will be passed to the Minor constructor
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.
[True, ‘ticks’, False, ‘all’, ‘allticks’]
Any
nticks¶Specifies the maximum number of ticks for the particular axis.
The actual number of ticks will be chosen automatically to be
less than or equal to nticks. Has an effect only if
tickmode is set to “auto”.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
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.
[‘free’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
position¶Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if anchor is set
to “free”.
An int or float in the interval [0, 1]
int|float
range¶type is “log”, thenyou 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:
a list or tuple of 2 elements where:
The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type
list
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:
An instance of
plotly.graph_objects.layout.xaxis.RangebreakA dict of string/value properties that will be passed to the Rangebreak constructor
rangebreaks¶The ‘rangebreaks’ property is a tuple of instances of Rangebreak that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.xaxis.Rangebreak
A list or tuple of dicts of string/value properties that will be passed to the Rangebreak constructor
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.
[‘normal’, ‘tozero’, ‘nonnegative’]
Any
rangeselector¶The ‘rangeselector’ property is an instance of Rangeselector that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.RangeselectorA dict of string/value properties that will be passed to the Rangeselector constructor
rangeslider¶The ‘rangeslider’ property is an instance of Rangeslider that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.RangesliderA dict of string/value properties that will be passed to the Rangeslider constructor
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).
[False]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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.
An int or float in the interval [0, inf]
int|float
separatethousands¶If “true”, even 4-digit integers are separated
The ‘separatethousands’ property must be specified as a bool (either True, or False)
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 must be specified as a bool (either True, or False)
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.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
showgrid¶Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.
The ‘showgrid’ property must be specified as a bool (either True, or False)
showline¶Determines whether or not a line bounding this axis is drawn.
The ‘showline’ property must be specified as a bool (either True, or False)
showspikes¶Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
The ‘showspikes’ property must be specified as a bool (either True, or False)
showticklabels¶Determines whether or not the tick labels are drawn.
The ‘showticklabels’ property must be specified as a bool (either True, or False)
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.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
showticksuffix¶Same as showtickprefix but for tick suffixes.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
side¶Determines whether a x (y) axis is positioned at the “bottom” (“left”) or “top” (“right”) of the plotting area.
[‘top’, ‘bottom’, ‘left’, ‘right’]
Any
spikecolor¶Sets the spike color. If undefined, will use the series color
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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”).
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
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:
Any combination of [‘toaxis’, ‘across’, ‘marker’] joined with ‘+’ characters (e.g. ‘toaxis+across’)
Any
spikesnap¶Determines whether spikelines are stuck to the cursor or to the closest datapoints.
[‘data’, ‘cursor’, ‘hovered data’]
Any
spikethickness¶Sets the width (in px) of the zero line.
An int or float
int|float
tick0¶Sets the placement of the first tick on this axis. Use with
dtick. If the axis type is “log”, then you must take the
log of your starting tick (e.g. to set the starting tick to
100, set the tick0 to 2) except when dtick`=*L<f>* (see
`dtick for more info). If the axis type is “date”, it should
be a date string, like date data. If the axis type is
“category”, it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
The ‘tick0’ property accepts values of any type
Any
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).
int|float
tickcolor¶Sets the tick color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
tickfont¶Sets the tick font.
The ‘tickfont’ property is an instance of Tickfont that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.TickfontA dict of string/value properties that will be passed to the Tickfont constructor
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”
A string
A number that will be converted to a string
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:
An instance of
plotly.graph_objects.layout.xaxis.TickformatstopA dict of string/value properties that will be passed to the Tickformatstop constructor
tickformatstops¶The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.xaxis.Tickformatstop
A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor
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.
An int (or float that will be cast to an int)
A tuple, list, or one-dimensional numpy array of the above
int|numpy.ndarray
ticklabelindexsrc¶Sets the source reference on Chart Studio Cloud for
ticklabelindex.
The ‘ticklabelindexsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
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.
[‘instant’, ‘period’]
Any
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.
[‘allow’, ‘hide past div’, ‘hide past domain’]
Any
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”. Similarly left or right has
no effect on y axes or when ticklabelmode is set to “period”.
Has no effect on “multicategory” axes or when tickson is set
to “boundaries”. 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.
[‘outside’, ‘inside’, ‘outside top’, ‘inside top’, ‘outside left’, ‘inside left’, ‘outside right’, ‘inside right’, ‘outside bottom’, ‘inside bottom’]
Any
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.
An int (or float that will be cast to an int)
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.
An int (or float that will be cast to an int)
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”.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
ticklen¶Sets the tick length (in px).
An int or float in the interval [0, inf]
int|float
tickmode¶Sets the tick mode for this axis. If “auto”, the number of
ticks is set via nticks. If “linear”, the placement of the
ticks is determined by a starting position tick0 and a tick
step dtick (“linear” is the default value if tick0 and
dtick are provided). If “array”, the placement of the ticks
is set via tickvals and the tick text is ticktext. (“array”
is the default value if tickvals is provided). If “sync”, the
number of ticks will sync with the overlayed axis set by
overlaying property.
[‘auto’, ‘linear’, ‘array’, ‘sync’]
Any
tickprefix¶Sets a tick label prefix.
A string
A number that will be converted to a string
ticks¶Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.
[‘outside’, ‘inside’, ‘’]
Any
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.
[‘labels’, ‘boundaries’]
Any
ticksuffix¶Sets a tick label suffix.
A string
A number that will be converted to a string
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
numpy.ndarray
ticktextsrc¶Sets the source reference on Chart Studio Cloud for ticktext.
The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickvals¶Sets the values at which ticks on this axis appear. Only has an
effect if tickmode is set to “array”. Used with ticktext.
The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
tickvalssrc¶Sets the source reference on Chart Studio Cloud for tickvals.
The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickwidth¶Sets the tick width (in px).
An int or float in the interval [0, inf]
int|float
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.layout.xaxis.TitleA dict of string/value properties that will be passed to the Title constructor
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.
[‘-‘, ‘linear’, ‘log’, ‘date’, ‘category’, ‘multicategory’]
Any
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
Any
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 must be specified as a bool (either True, or False)
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 must be specified as a bool (either True, or False)
zerolinecolor¶Sets the line color of the zero line.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
zerolinewidth¶Sets the width (in px) of the zero line.
An int or float
int|float
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, categoryarraysrc=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, mirror=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, 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, ticklabelindexsrc=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, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, type=None, uirevision=None, visible=None, zeroline=None, zerolinecolor=None, zerolinewidth=None, **kwargs)¶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.
[‘free’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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’)
Any
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.
[True, False, ‘reversed’, ‘min reversed’, ‘max reversed’, ‘min’, ‘max’]
Any
autorangeoptions¶The ‘autorangeoptions’ property is an instance of Autorangeoptions that may be specified as:
An instance of
plotly.graph_objects.layout.yaxis.AutorangeoptionsA dict of string/value properties that will be passed to the Autorangeoptions constructor
autoshift¶Automatically reposition the axis to avoid overlap with other
axes with the same overlaying value. This repositioning will
account for any shift amount applied to other axes on the
same side with autoshift is set to true. Only has an effect
if anchor is set to “free”.
The ‘autoshift’ property must be specified as a bool (either True, or False)
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).
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.
[‘convert types’, ‘strict’]
Any
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
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
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
numpy.ndarray
categoryarraysrc¶Sets the source reference on Chart Studio Cloud for
categoryarray.
The ‘categoryarraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
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.
[‘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’]
Any
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.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
[‘range’, ‘domain’]
Any
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.
[‘left’, ‘center’, ‘right’, ‘top’, ‘middle’, ‘bottom’]
Any
dividercolor¶Sets the color of the dividers Only has an effect on “multicategory” axes.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
dividerwidth¶Sets the width (in px) of the dividers Only has an effect on “multicategory” axes.
An int or float
int|float
domain¶Sets the domain of this axis (in plot fraction).
The ‘domain’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
An int or float in the interval [0, 1]
An int or float in the interval [0, 1]
list
dtick¶Sets the step in-between ticks on this axis. Use with tick0.
Must be a positive number, or special strings available to
“log” and “date” axes. If the axis type is “log”, then ticks
are set every 10^(n*dtick) where n is the tick number. For
example, to set a tick mark at 1, 10, 100, 1000, … set dtick
to 1. To set tick marks at 1, 100, 10000, … set dtick to 2.
To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to
log_10(5), or 0.69897000433. “log” has several special values;
“L<f>”, where f is a positive number, gives ticks linearly
spaced in value (but not position). For example tick0 = 0.1,
dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To
show powers of 10 plus small digits between, use “D1” (all
digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and
“D2”. If the axis type is “date”, then you must convert the
time to milliseconds. For example, to set the interval between
ticks to one day, set dtick to 86400000.0. “date” also has
special values “M<n>” gives ticks spaced by a number of months.
n must be a positive integer. To set ticks on the 15th of
every third month, set tick0 to “2000-01-15” and dtick to
“M3”. To set ticks every 4 years, set dtick to “M48”
The ‘dtick’ property accepts values of any type
Any
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.
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]
Any
fixedrange¶Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
The ‘fixedrange’ property must be specified as a bool (either True, or False)
gridcolor¶Sets the color of the grid lines.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
griddash¶Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
gridwidth¶Sets the width (in px) of the grid lines.
An int or float in the interval [0, inf]
int|float
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”
A string
A number that will be converted to a string
insiderange¶(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:
a list or tuple of 2 elements where:
The ‘insiderange[0]’ property accepts values of any type
The ‘insiderange[1]’ property accepts values of any type
list
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
Any
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.
[‘above traces’, ‘below traces’]
Any
linecolor¶Sets the axis line color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
linewidth¶Sets the width (in px) of the axis line.
An int or float in the interval [0, inf]
int|float
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.
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
maxallowed¶Determines the maximum range of this axis.
The ‘maxallowed’ property accepts values of any type
Any
minallowed¶Determines the minimum range of this axis.
The ‘minallowed’ property accepts values of any type
Any
minexponent¶Hide SI prefix for 10^n if |n| is below this number. This only
has an effect when tickformat is “SI” or “B”.
An int or float in the interval [0, inf]
int|float
minor¶The ‘minor’ property is an instance of Minor that may be specified as:
An instance of
plotly.graph_objects.layout.yaxis.MinorA dict of string/value properties that will be passed to the Minor constructor
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.
[True, ‘ticks’, False, ‘all’, ‘allticks’]
Any
nticks¶Specifies the maximum number of ticks for the particular axis.
The actual number of ticks will be chosen automatically to be
less than or equal to nticks. Has an effect only if
tickmode is set to “auto”.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
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.
[‘free’]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
position¶Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if anchor is set
to “free”.
An int or float in the interval [0, 1]
int|float
range¶type is “log”, thenyou 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:
a list or tuple of 2 elements where:
The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type
list
rangebreakdefaults¶When used in a template (as layout.template.layout.yaxis.rangebreakdefaults), sets the default property values to use for elements of layout.yaxis.rangebreaks
The ‘rangebreakdefaults’ property is an instance of Rangebreak that may be specified as:
An instance of
plotly.graph_objects.layout.yaxis.RangebreakA dict of string/value properties that will be passed to the Rangebreak constructor
rangebreaks¶The ‘rangebreaks’ property is a tuple of instances of Rangebreak that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.yaxis.Rangebreak
A list or tuple of dicts of string/value properties that will be passed to the Rangebreak constructor
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.
[‘normal’, ‘tozero’, ‘nonnegative’]
Any
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).
[False]
[‘^x([2-9]|[1-9][0-9]+)?( domain)?$’, ‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]
Any
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.
An int or float in the interval [0, inf]
int|float
separatethousands¶If “true”, even 4-digit integers are separated
The ‘separatethousands’ property must be specified as a bool (either True, or False)
shift¶Moves the axis a given number of pixels from where it would
have been otherwise. Accepts both positive and negative values,
which will shift the axis either right or left, respectively.
If autoshift is set to true, then this defaults to a padding
of -3 if side is set to “left”. and defaults to +3 if side
is set to “right”. Defaults to 0 if autoshift is set to
false. Only has an effect if anchor is set to “free”.
An int or float
int|float
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 must be specified as a bool (either True, or False)
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.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
showgrid¶Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.
The ‘showgrid’ property must be specified as a bool (either True, or False)
showline¶Determines whether or not a line bounding this axis is drawn.
The ‘showline’ property must be specified as a bool (either True, or False)
showspikes¶Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
The ‘showspikes’ property must be specified as a bool (either True, or False)
showticklabels¶Determines whether or not the tick labels are drawn.
The ‘showticklabels’ property must be specified as a bool (either True, or False)
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.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
showticksuffix¶Same as showtickprefix but for tick suffixes.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
side¶Determines whether a x (y) axis is positioned at the “bottom” (“left”) or “top” (“right”) of the plotting area.
[‘top’, ‘bottom’, ‘left’, ‘right’]
Any
spikecolor¶Sets the spike color. If undefined, will use the series color
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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”).
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
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:
Any combination of [‘toaxis’, ‘across’, ‘marker’] joined with ‘+’ characters (e.g. ‘toaxis+across’)
Any
spikesnap¶Determines whether spikelines are stuck to the cursor or to the closest datapoints.
[‘data’, ‘cursor’, ‘hovered data’]
Any
spikethickness¶Sets the width (in px) of the zero line.
An int or float
int|float
tick0¶Sets the placement of the first tick on this axis. Use with
dtick. If the axis type is “log”, then you must take the
log of your starting tick (e.g. to set the starting tick to
100, set the tick0 to 2) except when dtick`=*L<f>* (see
`dtick for more info). If the axis type is “date”, it should
be a date string, like date data. If the axis type is
“category”, it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
The ‘tick0’ property accepts values of any type
Any
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).
int|float
tickcolor¶Sets the tick color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
tickfont¶Sets the tick font.
The ‘tickfont’ property is an instance of Tickfont that may be specified as:
An instance of
plotly.graph_objects.layout.yaxis.TickfontA dict of string/value properties that will be passed to the Tickfont constructor
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”
A string
A number that will be converted to a string
tickformatstopdefaults¶When used in a template (as layout.template.layout.yaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.yaxis.tickformatstops
The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:
An instance of
plotly.graph_objects.layout.yaxis.TickformatstopA dict of string/value properties that will be passed to the Tickformatstop constructor
tickformatstops¶The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.yaxis.Tickformatstop
A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor
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.
An int (or float that will be cast to an int)
A tuple, list, or one-dimensional numpy array of the above
int|numpy.ndarray
ticklabelindexsrc¶Sets the source reference on Chart Studio Cloud for
ticklabelindex.
The ‘ticklabelindexsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
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.
[‘instant’, ‘period’]
Any
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.
[‘allow’, ‘hide past div’, ‘hide past domain’]
Any
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”. Similarly left or right has
no effect on y axes or when ticklabelmode is set to “period”.
Has no effect on “multicategory” axes or when tickson is set
to “boundaries”. 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.
[‘outside’, ‘inside’, ‘outside top’, ‘inside top’, ‘outside left’, ‘inside left’, ‘outside right’, ‘inside right’, ‘outside bottom’, ‘inside bottom’]
Any
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.
An int (or float that will be cast to an int)
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.
An int (or float that will be cast to an int)
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”.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
ticklen¶Sets the tick length (in px).
An int or float in the interval [0, inf]
int|float
tickmode¶Sets the tick mode for this axis. If “auto”, the number of
ticks is set via nticks. If “linear”, the placement of the
ticks is determined by a starting position tick0 and a tick
step dtick (“linear” is the default value if tick0 and
dtick are provided). If “array”, the placement of the ticks
is set via tickvals and the tick text is ticktext. (“array”
is the default value if tickvals is provided). If “sync”, the
number of ticks will sync with the overlayed axis set by
overlaying property.
[‘auto’, ‘linear’, ‘array’, ‘sync’]
Any
tickprefix¶Sets a tick label prefix.
A string
A number that will be converted to a string
ticks¶Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.
[‘outside’, ‘inside’, ‘’]
Any
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.
[‘labels’, ‘boundaries’]
Any
ticksuffix¶Sets a tick label suffix.
A string
A number that will be converted to a string
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
numpy.ndarray
ticktextsrc¶Sets the source reference on Chart Studio Cloud for ticktext.
The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickvals¶Sets the values at which ticks on this axis appear. Only has an
effect if tickmode is set to “array”. Used with ticktext.
The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
tickvalssrc¶Sets the source reference on Chart Studio Cloud for tickvals.
The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickwidth¶Sets the tick width (in px).
An int or float in the interval [0, inf]
int|float
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.layout.yaxis.TitleA dict of string/value properties that will be passed to the Title constructor
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.
[‘-‘, ‘linear’, ‘log’, ‘date’, ‘category’, ‘multicategory’]
Any
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
Any
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 must be specified as a bool (either True, or False)
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 must be specified as a bool (either True, or False)
zerolinecolor¶Sets the line color of the zero line.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
zerolinewidth¶Sets the width (in px) of the zero line.
An int or float
int|float