plotly.graph_objects.AngularAxis(*args, **kwargs)¶Bases: dict
plotly.graph_objects.AngularAxis is deprecated.
plotly.graph_objects.layout.AngularAxis
plotly.graph_objects.layout.polar.AngularAxis
plotly.graph_objects.Annotation(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Annotation is deprecated.
plotly.graph_objects.layout.Annotation
plotly.graph_objects.layout.scene.Annotation
plotly.graph_objects.Annotations(*args, **kwargs)¶Bases: list
plotly.graph_objects.Annotations is deprecated.
plotly.graph_objects.layout.Annotation
plotly.graph_objects.layout.scene.Annotation
plotly.graph_objects.Bar(arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
base¶Sets where the bar base is drawn (in position axis units). In “stack” or “relative” barmode, traces that set “base” will be excluded and drawn in “overlay” mode instead.
The ‘base’ property accepts values of any type
Any|numpy.ndarray
basesrc¶Sets the source reference on Chart Studio Cloud for base.
The ‘basesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
cliponaxis¶Determines whether the text nodes are clipped about the subplot
axes. To show the text nodes above axis lines and tick labels,
make sure to set xaxis.layer and yaxis.layer to below
traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
constraintext¶Constrain the size of text inside or outside a bar to be no larger than the bar itself.
[‘inside’, ‘outside’, ‘both’, ‘none’]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
error_x¶The ‘error_x’ property is an instance of ErrorX that may be specified as:
An instance of
plotly.graph_objects.bar.ErrorXA dict of string/value properties that will be passed to the ErrorX constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
copy_ystyle
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
error_y¶The ‘error_y’ property is an instance of ErrorY that may be specified as:
An instance of
plotly.graph_objects.bar.ErrorYA dict of string/value properties that will be passed to the ErrorY constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.bar.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables value and label.
Anything contained in tag <extra> is displayed in the
secondary box, for example “<extra>{fullData.name}</extra>”. To
hide the secondary box completely, use an empty tag
<extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextanchor¶Determines if texts are kept at center or start/end points in
textposition “inside” mode.
[‘end’, ‘middle’, ‘start’]
Any
insidetextfont¶Sets the font used for text lying inside the bar.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.bar.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
legend¶Sets the reference to a legend to show this trace 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 trace. 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.bar.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.bar.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.bar.marker.ColorBa rinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- cornerradius
Sets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to
layout.barcornerradius. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.- line
plotly.graph_objects.bar.marker.Lineinstance or dict with compatible properties- opacity
Sets the opacity of the bars.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- pattern
Sets the pattern within the marker.
- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
offset¶Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.
An int or float
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
offsetsrc¶Sets the source reference on Chart Studio Cloud for offset.
The ‘offsetsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
[‘v’, ‘h’]
Any
outsidetextfont¶Sets the font used for text lying outside the bar.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.bar.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.bar.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.bar.selected.Marke rinstance or dict with compatible properties- textfont
plotly.graph_objects.bar.selected.Textf ontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.bar.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textangle¶Sets the angle of the tick labels with respect to the bar. For
example, a tickangle of -90 draws the tick labels vertically.
With “auto” the texts may automatically be rotated to fit with
the maximum size in bars.
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
textfont¶Sets the font used for text.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.bar.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Specifies the location of the text. “inside” positions text
inside, next to the bar end (rotated and scaled if needed).
“outside” positions text outside, next to the bar end (scaled
if needed), unless there is another bar stacked on this one,
then the text gets pushed inside. “auto” tries to position
text inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If “none”, no
text appears.
[‘inside’, ‘outside’, ‘auto’, ‘none’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables value
and label.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.bar.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.bar.unselected.Mar kerinstance or dict with compatible properties- textfont
plotly.graph_objects.bar.unselected.Tex tfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
width¶Sets the bar width (in position axis units).
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
widthsrc¶Sets the source reference on Chart Studio Cloud for width.
The ‘widthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Barpolar(arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
base¶Sets where the bar base is drawn (in radial axis units). In “stack” barmode, traces that set “base” will be excluded and drawn in “overlay” mode instead.
The ‘base’ property accepts values of any type
Any|numpy.ndarray
basesrc¶Sets the source reference on Chart Studio Cloud for base.
The ‘basesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dr¶Sets the r coordinate step.
An int or float
int|float
dtheta¶Sets the theta coordinate step. By default, the dtheta step
equals the subplot’s period divided by the length of the r
coordinates.
An int or float
int|float
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘r’, ‘theta’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘r+theta’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.barpolar.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.barpolar.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.barpolar.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.barpolar.marker.Co lorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- line
plotly.graph_objects.barpolar.marker.Li neinstance or dict with compatible properties- opacity
Sets the opacity of the bars.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- pattern
Sets the pattern within the marker.
- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
offset¶Shifts the angular position where the bar is drawn (in “thetatunit” units).
An int or float
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
offsetsrc¶Sets the source reference on Chart Studio Cloud for offset.
The ‘offsetsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
r¶Sets the radial coordinates
The ‘r’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
r0¶Alternate to r. Builds a linear space of r coordinates. Use
with dr where r0 is the starting coordinate and dr the
step.
The ‘r0’ property accepts values of any type
Any
rsrc¶Sets the source reference on Chart Studio Cloud for r.
The ‘rsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.barpolar.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.barpolar.selected. Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.barpolar.selected. Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.barpolar.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
polar subplot. If “polar” (the default value), the data refer
to layout.polar. If “polar2”, the data refer to
layout.polar2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘polar’, that may be specified as the string ‘polar’ optionally followed by an integer >= 1 (e.g. ‘polar’, ‘polar1’, ‘polar2’, ‘polar3’, etc.)
text¶Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
theta¶Sets the angular coordinates
The ‘theta’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
theta0¶Alternate to theta. Builds a linear space of theta
coordinates. Use with dtheta where theta0 is the starting
coordinate and dtheta the step.
The ‘theta0’ property accepts values of any type
Any
thetasrc¶Sets the source reference on Chart Studio Cloud for theta.
The ‘thetasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
thetaunit¶Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.
[‘radians’, ‘degrees’, ‘gradians’]
Any
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.barpolar.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.barpolar.unselecte d.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.barpolar.unselecte d.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
width¶Sets the bar angular width (in “thetaunit” units).
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
plotly.graph_objects.Box(arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
boxmean¶If True, the mean of the box(es)’ underlying distribution is
drawn as a dashed line inside the box(es). If “sd” the standard
deviation is also drawn. Defaults to True when mean is set.
Defaults to “sd” when sd is set Otherwise defaults to False.
[True, ‘sd’, False]
Any
boxpoints¶If “outliers”, only the sample points lying outside the
whiskers are shown If “suspectedoutliers”, the outlier points
are shown and points either less than 4*Q1-3*Q3 or greater than
4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all
sample points are shown If False, only the box(es) are shown
with no sample points Defaults to “suspectedoutliers” when
marker.outliercolor or marker.line.outliercolor is set.
Defaults to “all” under the q1/median/q3 signature. Otherwise
defaults to “outliers”.
[‘all’, ‘outliers’, ‘suspectedoutliers’, False]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step for multi-box traces set using q1/median/q3.
An int or float
int|float
dy¶Sets the y coordinate step for multi-box traces set using q1/median/q3.
An int or float
int|float
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.box.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual boxes or sample points or both?
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘boxes’, ‘points’] joined with ‘+’ characters (e.g. ‘boxes+points’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
jitter¶Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es).
An int or float in the interval [0, 1]
int|float
legend¶Sets the reference to a legend to show this trace 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 trace. 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.box.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.box.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the color of line bounding the box(es).
- width
Sets the width (in px) of line bounding the box(es).
lowerfence¶Sets the lower fence values. There should be as many items as
the number of boxes desired. This attribute has effect only
under the q1/median/q3 signature. If lowerfence is not
provided but a sample (in y or x) is set, we compute the
lower as the last sample point below 1.5 times the IQR.
The ‘lowerfence’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lowerfencesrc¶Sets the source reference on Chart Studio Cloud for
lowerfence.
The ‘lowerfencesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.box.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- line
plotly.graph_objects.box.marker.Lineinstance or dict with compatible properties- opacity
Sets the marker opacity.
- outliercolor
Sets the color of the outlier sample points.
- size
Sets the marker size (in px).
- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
mean¶Sets the mean values. There should be as many items as the
number of boxes desired. This attribute has effect only under
the q1/median/q3 signature. If mean is not provided but a
sample (in y or x) is set, we compute the mean for each box
using the sample values.
The ‘mean’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
meansrc¶Sets the source reference on Chart Studio Cloud for mean.
The ‘meansrc’ property must be specified as a string or as a plotly.grid_objs.Column object
median¶Sets the median values. There should be as many items as the number of boxes desired.
The ‘median’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
mediansrc¶Sets the source reference on Chart Studio Cloud for median.
The ‘mediansrc’ property must be specified as a string or as a plotly.grid_objs.Column object
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item
and on hover. For box traces, the name will also be used for
the position coordinate, if x and x0 (y and y0 if
horizontal) are missing and the position axis is categorical
A string
A number that will be converted to a string
notched¶Determines whether or not notches are drawn. Notches displays a
confidence interval around the median. We compute the
confidence interval as median +/- 1.57 * IQR / sqrt(N), where
IQR is the interquartile range and N is the sample size. If two
boxes’ notches do not overlap there is 95% confidence their
medians differ. See
https://sites.google.com/site/davidsstatistics/home/notched-
box-plots for more info. Defaults to False unless notchwidth
or notchspan is set.
The ‘notched’ property must be specified as a bool (either True, or False)
notchspan¶Sets the notch span from the boxes’ median values. There
should be as many items as the number of boxes desired. This
attribute has effect only under the q1/median/q3 signature. If
notchspan is not provided but a sample (in y or x) is
set, we compute it as 1.57 * IQR / sqrt(N), where N is the
sample size.
The ‘notchspan’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
notchspansrc¶Sets the source reference on Chart Studio Cloud for
notchspan.
The ‘notchspansrc’ property must be specified as a string or as a plotly.grid_objs.Column object
notchwidth¶Sets the width of the notches relative to the box’ width. For example, with 0, the notches are as wide as the box(es).
An int or float in the interval [0, 0.5]
int|float
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶Sets the orientation of the box(es). If “v” (“h”), the distribution is visualized along the vertical (horizontal).
[‘v’, ‘h’]
Any
pointpos¶Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
An int or float in the interval [-2, 2]
int|float
q1¶Sets the Quartile 1 values. There should be as many items as the number of boxes desired.
The ‘q1’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
q1src¶Sets the source reference on Chart Studio Cloud for q1.
The ‘q1src’ property must be specified as a string or as a plotly.grid_objs.Column object
q3¶Sets the Quartile 3 values. There should be as many items as the number of boxes desired.
The ‘q3’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
q3src¶Sets the source reference on Chart Studio Cloud for q3.
The ‘q3src’ property must be specified as a string or as a plotly.grid_objs.Column object
quartilemethod¶Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
[‘linear’, ‘exclusive’, ‘inclusive’]
Any
sd¶Sets the standard deviation values. There should be as many
items as the number of boxes desired. This attribute has effect
only under the q1/median/q3 signature. If sd is not provided
but a sample (in y or x) is set, we compute the standard
deviation for each box using the sample values.
The ‘sd’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
sdmultiple¶Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev
An int or float in the interval [0, inf]
int|float
sdsrc¶Sets the source reference on Chart Studio Cloud for sd.
The ‘sdsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.box.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.box.selected.Marke rinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showwhiskers¶Determines whether or not whiskers are visible. Defaults to
true for sizemode “quartiles”, false for “sd”.
The ‘showwhiskers’ property must be specified as a bool (either True, or False)
sizemode¶Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc
[‘quartiles’, ‘sd’]
Any
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.box.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each sample value. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.box.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.box.unselected.Mar kerinstance or dict with compatible properties
upperfence¶Sets the upper fence values. There should be as many items as
the number of boxes desired. This attribute has effect only
under the q1/median/q3 signature. If upperfence is not
provided but a sample (in y or x) is set, we compute the
upper as the last sample point above 1.5 times the IQR.
The ‘upperfence’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
upperfencesrc¶Sets the source reference on Chart Studio Cloud for
upperfence.
The ‘upperfencesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
whiskerwidth¶Sets the width of the whiskers relative to the box’ width. For example, with 1, the whiskers are as wide as the box(es).
An int or float in the interval [0, 1]
int|float
width¶Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot.
An int or float in the interval [0, inf]
int|float
x¶Sets the x sample data or coordinates. See overview for more info.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y sample data or coordinates. See overview for more info.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Candlestick(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
close¶Sets the close values.
The ‘close’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
closesrc¶Sets the source reference on Chart Studio Cloud for close.
The ‘closesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
decreasing¶The ‘decreasing’ property is an instance of Decreasing that may be specified as:
An instance of
plotly.graph_objects.candlestick.DecreasingA dict of string/value properties that will be passed to the Decreasing constructor
Supported dict properties:
- fillcolor
Sets the fill color. Defaults to a half- transparent variant of the line color, marker color, or marker line color, whichever is available.
- line
plotly.graph_objects.candlestick.decrea sing.Lineinstance or dict with compatible properties
high¶Sets the high values.
The ‘high’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
highsrc¶Sets the source reference on Chart Studio Cloud for high.
The ‘highsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.candlestick.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.- split
Show hover information (open, close, high, low) in separate labels.
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
increasing¶The ‘increasing’ property is an instance of Increasing that may be specified as:
An instance of
plotly.graph_objects.candlestick.IncreasingA dict of string/value properties that will be passed to the Increasing constructor
Supported dict properties:
- fillcolor
Sets the fill color. Defaults to a half- transparent variant of the line color, marker color, or marker line color, whichever is available.
- line
plotly.graph_objects.candlestick.increa sing.Lineinstance or dict with compatible properties
legend¶Sets the reference to a legend to show this trace 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 trace. 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.candlestick.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.candlestick.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- width
Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via
increasing.line.widthanddecreasing.line.width.
low¶Sets the low values.
The ‘low’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lowsrc¶Sets the source reference on Chart Studio Cloud for low.
The ‘lowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
open¶Sets the open values.
The ‘open’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
opensrc¶Sets the source reference on Chart Studio Cloud for open.
The ‘opensrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.candlestick.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
whiskerwidth¶Sets the width of the whiskers relative to the box’ width. For example, with 1, the whiskers are as wide as the box(es).
An int or float in the interval [0, 1]
int|float
x¶Sets the x coordinates. If absent, linear coordinate will be generated.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Carpet(arg=None, a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
a¶An array containing values of the first parameter value
The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
a0¶Alternate to a. Builds a linear space of a coordinates. Use
with da where a0 is the starting coordinate and da the
step.
An int or float
int|float
aaxis¶The ‘aaxis’ property is an instance of Aaxis that may be specified as:
An instance of
plotly.graph_objects.carpet.AaxisA dict of string/value properties that will be passed to the Aaxis constructor
Supported dict properties:
- arraydtick
The stride between grid lines along the axis
- arraytick0
The starting index of grid lines along the axis
- autorange
Determines whether or not the range of this axis is computed in relation to the input data. See
rangemodefor more info. Ifrangeis provided, thenautorangeis set to False.- 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
typedetection. Defaults to layout.autotypenumbers.- categoryarray
Sets the order in which categories on this axis appear. Only has an effect if
categoryorderis set to “array”. Used withcategoryorder.- categoryarraysrc
Sets the source reference on Chart Studio Cloud for
categoryarray.- 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
categoryorderto category ascending or category descending if order should be determined by the alphanumerical order of the category names. Setcategoryorderto “array” to derive the ordering from the attributecategoryarray. If a category is not found in thecategoryarrayarray, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories incategoryarray.cheatertype
- 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.
- dtick
The stride between grid lines along the axis
- endline
Determines whether or not a line is drawn at along the final value of this axis. If True, the end line is drawn on top of the grid lines.
- endlinecolor
Sets the line color of the end line.
- endlinewidth
Sets the width (in px) of the end line.
- 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.
- fixedrange
Determines whether or not this axis is zoom- able. If true, then zoom is disabled.
- gridcolor
Sets the axis line color.
- griddash
Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
- gridwidth
Sets the width (in px) of the axis line.
- 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.
- labelpadding
Extra padding between label and the axis
- labelprefix
Sets a axis label prefix.
- labelsuffix
Sets a axis label suffix.
- linecolor
Sets the axis line color.
- linewidth
Sets the width (in px) of the axis line.
- minexponent
Hide SI prefix for 10^n if |n| is below this number
- minorgridcolor
Sets the color of the grid lines.
- minorgridcount
Sets the number of minor grid ticks per major grid tick
- minorgriddash
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”).
- minorgridwidth
Sets the width (in px) of the grid lines.
- nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to
nticks. Has an effect only iftickmodeis set to “auto”.- range
Sets the range of this axis. If the axis
typeis “log”, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axistypeis “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistypeis “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.- 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.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showgrid
Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.
- showline
Determines whether or not a line bounding this axis is drawn.
- showticklabels
Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.smoothing
- startline
Determines whether or not a line is drawn at along the starting value of this axis. If True, the start line is drawn on top of the grid lines.
- startlinecolor
Sets the line color of the start line.
- startlinewidth
Sets the width (in px) of the start line.
- tick0
The starting index of grid lines along the axis
- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickfont
Sets the tick font.
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.carpet. aaxis.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.carpet.aaxis.tickformatstopdefaults), sets the default property values to use for elements of carpet.aaxis.tickformatstops
tickmode
- tickprefix
Sets a tick label prefix.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- title
:class:`plotly.graph_objects.carpet.aaxis.Title ` instance or dict with compatible properties
- 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.
asrc¶Sets the source reference on Chart Studio Cloud for a.
The ‘asrc’ property must be specified as a string or as a plotly.grid_objs.Column object
b¶A two dimensional array of y coordinates at each carpet point.
The ‘b’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
b0¶Alternate to b. Builds a linear space of a coordinates. Use
with db where b0 is the starting coordinate and db the
step.
An int or float
int|float
baxis¶The ‘baxis’ property is an instance of Baxis that may be specified as:
An instance of
plotly.graph_objects.carpet.BaxisA dict of string/value properties that will be passed to the Baxis constructor
Supported dict properties:
- arraydtick
The stride between grid lines along the axis
- arraytick0
The starting index of grid lines along the axis
- autorange
Determines whether or not the range of this axis is computed in relation to the input data. See
rangemodefor more info. Ifrangeis provided, thenautorangeis set to False.- 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
typedetection. Defaults to layout.autotypenumbers.- categoryarray
Sets the order in which categories on this axis appear. Only has an effect if
categoryorderis set to “array”. Used withcategoryorder.- categoryarraysrc
Sets the source reference on Chart Studio Cloud for
categoryarray.- 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
categoryorderto category ascending or category descending if order should be determined by the alphanumerical order of the category names. Setcategoryorderto “array” to derive the ordering from the attributecategoryarray. If a category is not found in thecategoryarrayarray, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories incategoryarray.cheatertype
- 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.
- dtick
The stride between grid lines along the axis
- endline
Determines whether or not a line is drawn at along the final value of this axis. If True, the end line is drawn on top of the grid lines.
- endlinecolor
Sets the line color of the end line.
- endlinewidth
Sets the width (in px) of the end line.
- 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.
- fixedrange
Determines whether or not this axis is zoom- able. If true, then zoom is disabled.
- gridcolor
Sets the axis line color.
- griddash
Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
- gridwidth
Sets the width (in px) of the axis line.
- 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.
- labelpadding
Extra padding between label and the axis
- labelprefix
Sets a axis label prefix.
- labelsuffix
Sets a axis label suffix.
- linecolor
Sets the axis line color.
- linewidth
Sets the width (in px) of the axis line.
- minexponent
Hide SI prefix for 10^n if |n| is below this number
- minorgridcolor
Sets the color of the grid lines.
- minorgridcount
Sets the number of minor grid ticks per major grid tick
- minorgriddash
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”).
- minorgridwidth
Sets the width (in px) of the grid lines.
- nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to
nticks. Has an effect only iftickmodeis set to “auto”.- range
Sets the range of this axis. If the axis
typeis “log”, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axistypeis “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistypeis “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.- 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.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showgrid
Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.
- showline
Determines whether or not a line bounding this axis is drawn.
- showticklabels
Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.smoothing
- startline
Determines whether or not a line is drawn at along the starting value of this axis. If True, the start line is drawn on top of the grid lines.
- startlinecolor
Sets the line color of the start line.
- startlinewidth
Sets the width (in px) of the start line.
- tick0
The starting index of grid lines along the axis
- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickfont
Sets the tick font.
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.carpet. baxis.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.carpet.baxis.tickformatstopdefaults), sets the default property values to use for elements of carpet.baxis.tickformatstops
tickmode
- tickprefix
Sets a tick label prefix.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- title
:class:`plotly.graph_objects.carpet.baxis.Title ` instance or dict with compatible properties
- 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.
bsrc¶Sets the source reference on Chart Studio Cloud for b.
The ‘bsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
carpet¶An identifier for this carpet, so that scattercarpet and
contourcarpet traces can specify a carpet plot on which they
lie
A string
A number that will be converted to a string
cheaterslope¶The shift applied to each successive row of data in creating a
cheater plot. Only used if x is been omitted.
An int or float
int|float
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
da¶Sets the a coordinate step. See a0 for more info.
An int or float
int|float
db¶Sets the b coordinate step. See b0 for more info.
An int or float
int|float
font¶The default font used for axis & tick labels on this carpet
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.carpet.FontA dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.carpet.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.carpet.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶A two dimensional array of y coordinates at each carpet point.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Choropleth(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.choropleth.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.choropl eth.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.choropleth.colorbar.tickformatstopdefaults), sets the default property values to use for elements of choropleth.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.choropleth.colorba r.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
featureidkey¶Sets the key in GeoJSON features which is used as id to match
the items included in the locations array. Only has an effect
when geojson is set. Support nested property, for example
“properties.name”.
A string
A number that will be converted to a string
geo¶Sets a reference between this trace’s geospatial coordinates
and a geographic map. If “geo” (the default value), the
geospatial coordinates refer to layout.geo. If “geo2”, the
geospatial coordinates refer to layout.geo2, and so on.
The ‘geo’ property is an identifier of a particular subplot, of type ‘geo’, that may be specified as the string ‘geo’ optionally followed by an integer >= 1 (e.g. ‘geo’, ‘geo1’, ‘geo2’, ‘geo3’, etc.)
geojson¶Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.
The ‘geojson’ property accepts values of any type
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘location+z’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.choropleth.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.choropleth.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
locationmode¶Determines the set of locations used to match entries in
locations to regions on the map. Values “ISO-3”, “USA-
states”, country names correspond to features on the base map
and value “geojson-id” corresponds to features from a custom
GeoJSON linked to the geojson attribute.
[‘ISO-3’, ‘USA-states’, ‘country names’, ‘geojson-id’]
Any
locations¶Sets the coordinates via location IDs or names. See
locationmode for more info.
The ‘locations’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
locationssrc¶Sets the source reference on Chart Studio Cloud for
locations.
The ‘locationssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.choropleth.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- line
plotly.graph_objects.choropleth.marker. Lineinstance or dict with compatible properties- opacity
Sets the opacity of the locations.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.choropleth.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.choropleth.selecte d.Markerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.choropleth.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each location.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.choropleth.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.choropleth.unselec ted.Markerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
z¶Sets the color values.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
plotly.graph_objects.Choroplethmap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
below¶Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.choroplethmap.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.choropl ethmap.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.choroplethmap.colorbar.tickformatstopdefaults ), sets the default property values to use for elements of choroplethmap.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.choroplethmap.colo rbar.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
featureidkey¶Sets the key in GeoJSON features which is used as id to match
the items included in the locations array. Support nested
property, for example “properties.name”.
A string
A number that will be converted to a string
geojson¶Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.
The ‘geojson’ property accepts values of any type
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘location+z’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.choroplethmap.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variable properties Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.choroplethmap.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
locations¶Sets which features found in “geojson” to plot using their
feature id field.
The ‘locations’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
locationssrc¶Sets the source reference on Chart Studio Cloud for
locations.
The ‘locationssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.choroplethmap.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- line
plotly.graph_objects.choroplethmap.mark er.Lineinstance or dict with compatible properties- opacity
Sets the opacity of the locations.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.choroplethmap.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.choroplethmap.sele cted.Markerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.choroplethmap.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
map subplot. If “map” (the default value), the data refer to
layout.map. If “map2”, the data refer to layout.map2, and
so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘map’, that may be specified as the string ‘map’ optionally followed by an integer >= 1 (e.g. ‘map’, ‘map1’, ‘map2’, ‘map3’, etc.)
text¶Sets the text elements associated with each location.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.choroplethmap.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.choroplethmap.unse lected.Markerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
z¶Sets the color values.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
plotly.graph_objects.Choroplethmapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
below¶Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.choroplethmapbox.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.choropl ethmapbox.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.choroplethmapbox.colorbar.tickformatstopdefau lts), sets the default property values to use for elements of choroplethmapbox.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.choroplethmapbox.c olorbar.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
featureidkey¶Sets the key in GeoJSON features which is used as id to match
the items included in the locations array. Support nested
property, for example “properties.name”.
A string
A number that will be converted to a string
geojson¶Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.
The ‘geojson’ property accepts values of any type
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘location+z’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.choroplethmapbox.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variable properties Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.choroplethmapbox.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
locations¶Sets which features found in “geojson” to plot using their
feature id field.
The ‘locations’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
locationssrc¶Sets the source reference on Chart Studio Cloud for
locations.
The ‘locationssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.choroplethmapbox.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- line
plotly.graph_objects.choroplethmapbox.m arker.Lineinstance or dict with compatible properties- opacity
Sets the opacity of the locations.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.choroplethmapbox.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.choroplethmapbox.s elected.Markerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.choroplethmapbox.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶mapbox subplots and traces are deprecated! Please consider
switching to map subplots and traces. Learn more at:
https://plotly.com/python/maplibre-migration/ as well as
https://plotly.com/javascript/maplibre-migration/ Sets a
reference between this trace’s data coordinates and a mapbox
subplot. If “mapbox” (the default value), the data refer to
layout.mapbox. If “mapbox2”, the data refer to
layout.mapbox2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘mapbox’, that may be specified as the string ‘mapbox’ optionally followed by an integer >= 1 (e.g. ‘mapbox’, ‘mapbox1’, ‘mapbox2’, ‘mapbox3’, etc.)
text¶Sets the text elements associated with each location.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.choroplethmapbox.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.choroplethmapbox.u nselected.Markerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
z¶Sets the color values.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
plotly.graph_objects.ColorBar(*args, **kwargs)¶Bases: dict
plotly.graph_objects.ColorBar is deprecated.
plotly.graph_objects.scatter.marker.ColorBar
plotly.graph_objects.surface.ColorBar
etc.
plotly.graph_objects.Cone(arg=None, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
anchor¶Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.
[‘tip’, ‘tail’, ‘cm’, ‘center’]
Any
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 u/v/w norm) 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 u/v/w norm 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 u/v/w norm. 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 u/v/w norm and if set, cmax must be set as
well.
An int or float
int|float
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.cone.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.cone.co lorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.cone.colorbar.tickformatstopdefaults), sets the default property values to use for elements of cone.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.cone.colorbar.Titl einstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘u’, ‘v’, ‘w’, ‘norm’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.cone.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variable norm Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.cone.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lighting¶The ‘lighting’ property is an instance of Lighting that may be specified as:
An instance of
plotly.graph_objects.cone.LightingA dict of string/value properties that will be passed to the Lighting constructor
Supported dict properties:
- ambient
Ambient light increases overall color visibility but can wash out the image.
- diffuse
Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
lightposition¶The ‘lightposition’ property is an instance of Lightposition that may be specified as:
An instance of
plotly.graph_objects.cone.LightpositionA dict of string/value properties that will be passed to the Lightposition constructor
Supported dict properties:
- x
Numeric vector, representing the X coordinate for each vertex.
- y
Numeric vector, representing the Y coordinate for each vertex.
- z
Numeric vector, representing the Z coordinate for each vertex.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the surface. Please note that in the case
of using high opacity values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the webgl API. This behavior may be
improved in the near future and is subject to change.
An int or float in the interval [0, 1]
int|float
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)
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
sizemode¶Determines whether sizeref is set as a “scaled” (i.e
unitless) scalar (normalized by the max u/v/w norm in the
vector field) or as “absolute” value (in the same units as the
vector field). To display sizes in actual vector length use
“raw”.
[‘scaled’, ‘absolute’, ‘raw’]
Any
sizeref¶Adjusts the cone size scaling. The size of the cones is
determined by their u/v/w norm multiplied a factor and
sizeref. This factor (computed internally) corresponds to the
minimum “time” to travel across two successive x/y/z positions
at the average velocity of those two successive positions. All
cones in a given trace use the same factor. With sizemode set
to “raw”, its default value is 1. With sizemode set to
“scaled”, sizeref is unitless, its default value is 0.5. With
sizemode set to “absolute”, sizeref has the same units as
the u/v/w vector field, its the default value is half the
sample’s maximum vector norm.
An int or float in the interval [0, inf]
int|float
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.cone.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with the cones. If trace
hoverinfo contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶u¶Sets the x components of the vector field.
The ‘u’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
uhoverformat¶Sets the hover text formatting rulefor u 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
usrc¶Sets the source reference on Chart Studio Cloud for u.
The ‘usrc’ property must be specified as a string or as a plotly.grid_objs.Column object
v¶Sets the y components of the vector field.
The ‘v’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
vhoverformat¶Sets the hover text formatting rulefor v 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
vsrc¶Sets the source reference on Chart Studio Cloud for v.
The ‘vsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
w¶Sets the z components of the vector field.
The ‘w’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
whoverformat¶Sets the hover text formatting rulefor w 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
wsrc¶Sets the source reference on Chart Studio Cloud for w.
The ‘wsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
x¶Sets the x coordinates of the vector field and of the displayed cones.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates of the vector field and of the displayed cones.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the z coordinates of the vector field and of the displayed cones.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Contour(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
autocontour¶Determines whether or not the contour level attributes are
picked by an algorithm. If True, the number of contour levels
can be set in ncontours. If False, set the contour level
attributes in contours.
The ‘autocontour’ property must be specified as a bool (either True, or False)
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.contour.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.contour .colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.contour.colorbar.tickformatstopdefaults), sets the default property values to use for elements of contour.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.contour.colorbar.T itleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values)
in the z data are filled in. It is defaulted to true if z
is a one dimensional array otherwise it is defaulted to false.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
contours¶The ‘contours’ property is an instance of Contours that may be specified as:
An instance of
plotly.graph_objects.contour.ContoursA dict of string/value properties that will be passed to the Contours constructor
Supported dict properties:
- coloring
Determines the coloring method showing the contour values. If “fill”, coloring is done evenly between each contour level If “heatmap”, a heatmap gradient coloring is applied between each contour level. If “lines”, coloring is done on the contour lines. If “none”, no coloring is applied on this trace.
- end
Sets the end contour level value. Must be more than
contours.start- labelfont
Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from
layout.font.- labelformat
Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
- operation
Sets the constraint operation. “=” keeps regions equal to
value“<” and “<=” keep regions less thanvalue“>” and “>=” keep regions greater thanvalue“[]”, “()”, “[)”, and “(]” keep regions insidevalue[0]tovalue[1]“][“, “)(“, “](“, “)[” keep regions outsidevalue[0]to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.- showlabels
Determines whether to label the contour lines with their values.
- showlines
Determines whether or not the contour lines are drawn. Has an effect only if
contours.coloringis set to “fill”.- size
Sets the step between each contour level. Must be positive.
- start
Sets the starting contour level value. Must be less than
contours.end- type
If
levels, the data is represented as a contour plot with multiple levels displayed. Ifconstraint, the data is represented as constraints with the invalid region shaded as specified by theoperationandvalueparameters.- value
Sets the value or values of the constraint boundary. When
operationis set to one of the comparison values (=,<,>=,>,<=) “value” is expected to be a number. Whenoperationis set to one of the interval values ([],(),[),(],][,)(,](,)[) “value” is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
fillcolor¶Sets the fill color if contours.type is “constraint”.
Defaults to a half-transparent variant of the line color,
marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to contour.colorscale
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.contour.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoverongaps¶Determines whether or not gaps (i.e. {nan} or missing values)
in the z data have hover labels associated with them.
The ‘hoverongaps’ property must be specified as a bool (either True, or False)
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
The ‘hovertext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.contour.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.contour.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the color of the contour level. Has no effect if
contours.coloringis set to “lines”.- dash
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”).
- smoothing
Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.
- width
Sets the contour line width in (in px) Defaults to 0.5 when
contours.typeis “levels”. Defaults to 2 whencontour.typeis “constraint”.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
ncontours¶Sets the maximum number of contour levels. The actual number of
contours will be chosen automatically to be less than or equal
to the value of ncontours. Has an effect only if
autocontour is True or if contours.size is missing.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.contour.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each z value.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶For this trace it only has an effect if coloring is set to
“heatmap”. Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.contour.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶For this trace it only has an effect if coloring is set to
“heatmap”. Template string used for rendering the information
text that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable}, for
example “y: %{y}”. Numbers are formatted using d3-format’s
syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables x, y,
z and text.
A string
A number that will be converted to a string
transpose¶Transposes the z data.
The ‘transpose’ property must be specified as a bool (either True, or False)
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
xtype¶If “array”, the heatmap’s x coordinates are given by “x” (the
default behavior when x is provided). If “scaled”, the
heatmap’s x coordinates are given by “x0” and “dx” (the default
behavior when x is not provided).
[‘array’, ‘scaled’]
Any
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ytype¶If “array”, the heatmap’s y coordinates are given by “y” (the
default behavior when y is provided) If “scaled”, the
heatmap’s y coordinates are given by “y0” and “dy” (the default
behavior when y is not provided)
[‘array’, ‘scaled’]
Any
z¶Sets the z data.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zhoverformat¶Sets the hover text formatting rulefor z 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Contourcarpet(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
a¶Sets the x coordinates.
The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
a0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘a0’ property accepts values of any type
Any
asrc¶Sets the source reference on Chart Studio Cloud for a.
The ‘asrc’ property must be specified as a string or as a plotly.grid_objs.Column object
atype¶If “array”, the heatmap’s x coordinates are given by “x” (the
default behavior when x is provided). If “scaled”, the
heatmap’s x coordinates are given by “x0” and “dx” (the default
behavior when x is not provided).
[‘array’, ‘scaled’]
Any
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)
autocontour¶Determines whether or not the contour level attributes are
picked by an algorithm. If True, the number of contour levels
can be set in ncontours. If False, set the contour level
attributes in contours.
The ‘autocontour’ property must be specified as a bool (either True, or False)
b¶Sets the y coordinates.
The ‘b’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
b0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘b0’ property accepts values of any type
Any
bsrc¶Sets the source reference on Chart Studio Cloud for b.
The ‘bsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
btype¶If “array”, the heatmap’s y coordinates are given by “y” (the
default behavior when y is provided) If “scaled”, the
heatmap’s y coordinates are given by “y0” and “dy” (the default
behavior when y is not provided)
[‘array’, ‘scaled’]
Any
carpet¶The carpet of the carpet axes on which this contour trace
lies
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.contour carpet.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.contourcarpet.colorbar.tickformatstopdefaults ), sets the default property values to use for elements of contourcarpet.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.contourcarpet.colo rbar.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
contours¶The ‘contours’ property is an instance of Contours that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.ContoursA dict of string/value properties that will be passed to the Contours constructor
Supported dict properties:
- coloring
Determines the coloring method showing the contour values. If “fill”, coloring is done evenly between each contour level If “lines”, coloring is done on the contour lines. If “none”, no coloring is applied on this trace.
- end
Sets the end contour level value. Must be more than
contours.start- labelfont
Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from
layout.font.- labelformat
Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
- operation
Sets the constraint operation. “=” keeps regions equal to
value“<” and “<=” keep regions less thanvalue“>” and “>=” keep regions greater thanvalue“[]”, “()”, “[)”, and “(]” keep regions insidevalue[0]tovalue[1]“][“, “)(“, “](“, “)[” keep regions outsidevalue[0]to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.- showlabels
Determines whether to label the contour lines with their values.
- showlines
Determines whether or not the contour lines are drawn. Has an effect only if
contours.coloringis set to “fill”.- size
Sets the step between each contour level. Must be positive.
- start
Sets the starting contour level value. Must be less than
contours.end- type
If
levels, the data is represented as a contour plot with multiple levels displayed. Ifconstraint, the data is represented as constraints with the invalid region shaded as specified by theoperationandvalueparameters.- value
Sets the value or values of the constraint boundary. When
operationis set to one of the comparison values (=,<,>=,>,<=) “value” is expected to be a number. Whenoperationis set to one of the interval values ([],(),[),(],][,)(,](,)[) “value” is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
da¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
db¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
fillcolor¶Sets the fill color if contours.type is “constraint”.
Defaults to a half-transparent variant of the line color,
marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to contourcarpet.colorscale
hovertext¶Same as text.
The ‘hovertext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.contourcarpet.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.contourcarpet.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the color of the contour level. Has no effect if
contours.coloringis set to “lines”.- dash
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”).
- smoothing
Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.
- width
Sets the contour line width in (in px) Defaults to 0.5 when
contours.typeis “levels”. Defaults to 2 whencontour.typeis “constraint”.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
ncontours¶Sets the maximum number of contour levels. The actual number of
contours will be chosen automatically to be less than or equal
to the value of ncontours. Has an effect only if
autocontour is True or if contours.size is missing.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each z value.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
transpose¶Transposes the z data.
The ‘transpose’ property must be specified as a bool (either True, or False)
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
z¶Sets the z data.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Contours(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Contours is deprecated.
plotly.graph_objects.contour.Contours
plotly.graph_objects.surface.Contours
etc.
plotly.graph_objects.Data(*args, **kwargs)¶Bases: list
plotly.graph_objects.Data is deprecated.
plotly.graph_objects.Scatter
plotly.graph_objects.Bar
plotly.graph_objects.Area
plotly.graph_objects.Histogram
etc.
plotly.graph_objects.Densitymap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
below¶Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.densitymap.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.density map.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.densitymap.colorbar.tickformatstopdefaults), sets the default property values to use for elements of densitymap.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.densitymap.colorba r.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lon’, ‘lat’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘lon+lat’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.densitymap.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (lon,lat) pair If
a single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
lat¶Sets the latitude coordinates (in degrees North).
The ‘lat’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
latsrc¶Sets the source reference on Chart Studio Cloud for lat.
The ‘latsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.densitymap.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lon¶Sets the longitude coordinates (in degrees East).
The ‘lon’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lonsrc¶Sets the source reference on Chart Studio Cloud for lon.
The ‘lonsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
radius¶Sets the radius of influence of one lon / lat point in
pixels. Increasing the value makes the densitymap trace
smoother, but less detailed.
An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
radiussrc¶Sets the source reference on Chart Studio Cloud for radius.
The ‘radiussrc’ property must be specified as a string or as a plotly.grid_objs.Column object
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.densitymap.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
map subplot. If “map” (the default value), the data refer to
layout.map. If “map2”, the data refer to layout.map2, and
so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘map’, that may be specified as the string ‘map’ optionally followed by an integer >= 1 (e.g. ‘map’, ‘map1’, ‘map2’, ‘map3’, etc.)
text¶Sets text elements associated with each (lon,lat) pair If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. If trace hoverinfo
contains a “text” flag and “hovertext” is not set, these
elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
z¶Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
plotly.graph_objects.Densitymapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
below¶Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.densitymapbox.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.density mapbox.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.densitymapbox.colorbar.tickformatstopdefaults ), sets the default property values to use for elements of densitymapbox.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.densitymapbox.colo rbar.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lon’, ‘lat’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘lon+lat’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.densitymapbox.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (lon,lat) pair If
a single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
lat¶Sets the latitude coordinates (in degrees North).
The ‘lat’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
latsrc¶Sets the source reference on Chart Studio Cloud for lat.
The ‘latsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.densitymapbox.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lon¶Sets the longitude coordinates (in degrees East).
The ‘lon’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lonsrc¶Sets the source reference on Chart Studio Cloud for lon.
The ‘lonsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
radius¶Sets the radius of influence of one lon / lat point in
pixels. Increasing the value makes the densitymapbox trace
smoother, but less detailed.
An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
radiussrc¶Sets the source reference on Chart Studio Cloud for radius.
The ‘radiussrc’ property must be specified as a string or as a plotly.grid_objs.Column object
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.densitymapbox.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶mapbox subplots and traces are deprecated! Please consider
switching to map subplots and traces. Learn more at:
https://plotly.com/python/maplibre-migration/ as well as
https://plotly.com/javascript/maplibre-migration/ Sets a
reference between this trace’s data coordinates and a mapbox
subplot. If “mapbox” (the default value), the data refer to
layout.mapbox. If “mapbox2”, the data refer to
layout.mapbox2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘mapbox’, that may be specified as the string ‘mapbox’ optionally followed by an integer >= 1 (e.g. ‘mapbox’, ‘mapbox1’, ‘mapbox2’, ‘mapbox3’, etc.)
text¶Sets text elements associated with each (lon,lat) pair If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. If trace hoverinfo
contains a “text” flag and “hovertext” is not set, these
elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
z¶Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
plotly.graph_objects.ErrorX(*args, **kwargs)¶Bases: dict
plotly.graph_objects.ErrorX is deprecated.
plotly.graph_objects.scatter.ErrorX
plotly.graph_objects.histogram.ErrorX
etc.
plotly.graph_objects.ErrorY(*args, **kwargs)¶Bases: dict
plotly.graph_objects.ErrorY is deprecated.
plotly.graph_objects.scatter.ErrorY
plotly.graph_objects.histogram.ErrorY
etc.
plotly.graph_objects.ErrorZ(*args, **kwargs)¶Bases: dict
plotly.graph_objects.ErrorZ is deprecated.
plotly.graph_objects.scatter3d.ErrorZ
plotly.graph_objects.Figure(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)¶Bases: plotly.basedatatypes.BaseFigure
add_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, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure¶Create and add a new annotation to the figure’s layout
arg – instance of Annotation or dict with compatible properties
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.
arrowcolor – Sets the color of the annotation arrow.
arrowhead – Sets the end annotation arrow head style.
arrowside – Sets the annotation arrow head position.
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.
arrowwidth – Sets the width (in px) of annotation arrow line.
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.
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.
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.
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.
bgcolor – Sets the background color of the annotation.
bordercolor – Sets the color of the border enclosing the annotation
text.
borderpad – Sets the padding (in px) between the text and the
enclosing border.
borderwidth – Sets the width (in px) of the border enclosing the
annotation text.
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.
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.
font – Sets the annotation text font.
height – Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.
hoverlabel – plotly.graph_objects.layout.annotation.Hoverlab
el instance or dict with compatible properties
hovertext – Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.
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.
opacity – Sets the opacity of the annotation (text + arrow).
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.
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.
startarrowhead – Sets the start annotation arrow head style.
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.
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.
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.
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.
textangle – Sets the angle at which the text is drawn with
respect to the horizontal.
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.
visible – Determines whether or not this annotation is visible.
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.
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.
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.
xclick – Toggle this annotation when clicking a data point whose
x value is xclick rather than the annotation’s x
value.
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.
xshift – Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.
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.
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.
yclick – Toggle this annotation when clicking a data point whose
y value is yclick rather than the annotation’s y
value.
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.
yshift – Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
row – Subplot row for annotation. If ‘all’, addresses all rows in the specified column(s).
col – Subplot column for annotation. If ‘all’, addresses all columns in the specified row(s).
secondary_y – Whether to add annotation to secondary y-axis
exclude_empty_subplots – If True, annotation will not be added to subplots without traces.
add_bar(alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Bar trace
The data visualized by the span of the bars is set in y if
orientation is set to “v” (the default) and the labels are
set in x. By setting orientation to “h”, the roles are
interchanged.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
base – Sets where the bar base is drawn (in position axis units). In “stack” or “relative” barmode, traces that set “base” will be excluded and drawn in “overlay” mode instead.
basesrc – Sets the source reference on Chart Studio Cloud for
base.
cliponaxis – Determines whether the text nodes are clipped about the
subplot axes. To show the text nodes above axis lines
and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
constraintext – Constrain the size of text inside or outside a bar to be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.bar.ErrorX instance or
dict with compatible properties
error_y – plotly.graph_objects.bar.ErrorY instance or
dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.bar.Hoverlabel instance
or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables value and label. Anything contained in
tag <extra> is displayed in the secondary box, for
example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag
<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextanchor – Determines if texts are kept at center or start/end
points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.bar.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.bar.Marker instance or
dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
offsetsrc – Sets the source reference on Chart Studio Cloud for
offset.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
selected – plotly.graph_objects.bar.Selected instance or
dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.bar.Stream instance or
dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textangle – Sets the angle of the tick labels with respect to the
bar. For example, a tickangle of -90 draws the tick
labels vertically. With “auto” the texts may
automatically be rotated to fit with the maximum size
in bars.
textfont – Sets the font used for text.
textposition – Specifies the location of the text. “inside”
positions text inside, next to the bar end (rotated
and scaled if needed). “outside” positions text
outside, next to the bar end (scaled if needed), unless
there is another bar stacked on this one, then the text
gets pushed inside. “auto” tries to position text
inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If
“none”, no text appears.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables value and label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.bar.Unselected instance
or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
width – Sets the bar width (in position axis units).
widthsrc – Sets the source reference on Chart Studio Cloud for
width.
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_barpolar(base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Barpolar trace
The data visualized by the radial span of the bars is set in
r
base – Sets where the bar base is drawn (in radial axis units). In “stack” barmode, traces that set “base” will be excluded and drawn in “overlay” mode instead.
basesrc – Sets the source reference on Chart Studio Cloud for
base.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the
dtheta step equals the subplot’s period divided by
the length of the r coordinates.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.barpolar.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.barpolar.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.barpolar.Marker instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
offset – Shifts the angular position where the bar is drawn (in “thetatunit” units).
offsetsrc – Sets the source reference on Chart Studio Cloud for
offset.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r
coordinates. Use with dr where r0 is the starting
coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for
r.
selected – plotly.graph_objects.barpolar.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.barpolar.Stream instance
or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a polar subplot. If “polar” (the default value),
the data refer to layout.polar. If “polar2”, the data
refer to layout.polar2, and so on.
text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta
coordinates. Use with dtheta where theta0 is the
starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for
theta.
thetaunit – Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.barpolar.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
width – Sets the bar angular width (in “thetaunit” units).
widthsrc – Sets the source reference on Chart Studio Cloud for
width.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_box(alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Box trace
Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
second quartile (Q2, i.e. the median) is marked by a line
inside the box. The fences grow outward from the boxes’ edges,
by default they span +/- 1.5 times the interquartile range
(IQR: Q3-Q1), The sample mean and standard deviation as well as
notches and the sample, outlier and suspected outliers points
can be optionally added to the box plot. The values and
positions corresponding to each boxes can be input using two
signatures. The first signature expects users to supply the
sample values in the y data array for vertical boxes (x for
horizontal boxes). By supplying an x (y) array, one box per
distinct x (y) value is drawn If no x (y) list is
provided, a single box is drawn. In this case, the box is
positioned with the trace name or with x0 (y0) if
provided. The second signature expects users to supply the
boxes corresponding Q1, median and Q3 statistics in the q1,
median and q3 data arrays respectively. Other box features
relying on statistics namely lowerfence, upperfence,
notchspan can be set directly by the users. To have plotly
compute them or to show sample points besides the boxes, users
can set the y data array for vertical boxes (x for
horizontal boxes) to a 2D array with the outer length
corresponding to the number of boxes in the traces and the
inner length corresponding the sample size.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
boxmean – If True, the mean of the box(es)’ underlying
distribution is drawn as a dashed line inside the
box(es). If “sd” the standard deviation is also drawn.
Defaults to True when mean is set. Defaults to “sd”
when sd is set Otherwise defaults to False.
boxpoints – If “outliers”, only the sample points lying outside the
whiskers are shown If “suspectedoutliers”, the outlier
points are shown and points either less than 4*Q1-3*Q3
or greater than 4*Q3-3*Q1 are highlighted (see
outliercolor) If “all”, all sample points are shown
If False, only the box(es) are shown with no sample
points Defaults to “suspectedoutliers” when
marker.outliercolor or marker.line.outliercolor is
set. Defaults to “all” under the q1/median/q3
signature. Otherwise defaults to “outliers”.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step for multi-box traces set using q1/median/q3.
dy – Sets the y coordinate step for multi-box traces set using q1/median/q3.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.box.Hoverlabel instance
or dict with compatible properties
hoveron – Do the hover effects highlight individual boxes or sample points or both?
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
jitter – Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es).
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.box.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.box.Line instance or dict
with compatible properties
lowerfence – Sets the lower fence values. There should be as many
items as the number of boxes desired. This attribute
has effect only under the q1/median/q3 signature. If
lowerfence is not provided but a sample (in y or
x) is set, we compute the lower as the last sample
point below 1.5 times the IQR.
lowerfencesrc – Sets the source reference on Chart Studio Cloud for
lowerfence.
marker – plotly.graph_objects.box.Marker instance or
dict with compatible properties
mean – Sets the mean values. There should be as many items as
the number of boxes desired. This attribute has effect
only under the q1/median/q3 signature. If mean is not
provided but a sample (in y or x) is set, we
compute the mean for each box using the sample values.
meansrc – Sets the source reference on Chart Studio Cloud for
mean.
median – Sets the median values. There should be as many items as the number of boxes desired.
mediansrc – Sets the source reference on Chart Studio Cloud for
median.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the
legend item and on hover. For box traces, the name will
also be used for the position coordinate, if x and
x0 (y and y0 if horizontal) are missing and the
position axis is categorical
notched – Determines whether or not notches are drawn. Notches
displays a confidence interval around the median. We
compute the confidence interval as median +/- 1.57 *
IQR / sqrt(N), where IQR is the interquartile range and
N is the sample size. If two boxes’ notches do not
overlap there is 95% confidence their medians differ.
See https://sites.google.com/site/davidsstatistics/home
/notched-box-plots for more info. Defaults to False
unless notchwidth or notchspan is set.
notchspan – Sets the notch span from the boxes’ median values.
There should be as many items as the number of boxes
desired. This attribute has effect only under the
q1/median/q3 signature. If notchspan is not provided
but a sample (in y or x) is set, we compute it as
1.57 * IQR / sqrt(N), where N is the sample size.
notchspansrc – Sets the source reference on Chart Studio Cloud for
notchspan.
notchwidth – Sets the width of the notches relative to the box’ width. For example, with 0, the notches are as wide as the box(es).
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the box(es). If “v” (“h”), the distribution is visualized along the vertical (horizontal).
pointpos – Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
q1 – Sets the Quartile 1 values. There should be as many items as the number of boxes desired.
q1src – Sets the source reference on Chart Studio Cloud for
q1.
q3 – Sets the Quartile 3 values. There should be as many items as the number of boxes desired.
q3src – Sets the source reference on Chart Studio Cloud for
q3.
quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
sd – Sets the standard deviation values. There should be as
many items as the number of boxes desired. This
attribute has effect only under the q1/median/q3
signature. If sd is not provided but a sample (in y
or x) is set, we compute the standard deviation for
each box using the sample values.
sdmultiple – Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev
sdsrc – Sets the source reference on Chart Studio Cloud for
sd.
selected – plotly.graph_objects.box.Selected instance or
dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showwhiskers – Determines whether or not whiskers are visible.
Defaults to true for sizemode “quartiles”, false for
“sd”.
sizemode – Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc
stream – plotly.graph_objects.box.Stream instance or
dict with compatible properties
text – Sets the text elements associated with each sample
value. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.box.Unselected instance
or dict with compatible properties
upperfence – Sets the upper fence values. There should be as many
items as the number of boxes desired. This attribute
has effect only under the q1/median/q3 signature. If
upperfence is not provided but a sample (in y or
x) is set, we compute the upper as the last sample
point above 1.5 times the IQR.
upperfencesrc – Sets the source reference on Chart Studio Cloud for
upperfence.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
whiskerwidth – Sets the width of the whiskers relative to the box’ width. For example, with 1, the whiskers are as wide as the box(es).
width – Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot.
x – Sets the x sample data or coordinates. See overview for more info.
x0 – Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y sample data or coordinates. See overview for more info.
y0 – Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_candlestick(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Candlestick trace
The candlestick is a style of financial chart describing open,
high, low and close for a given x coordinate (most likely
time). The boxes represent the spread between the open and
close values and the lines represent the spread between the
low and high values Sample points where the close value is
higher (lower) then the open value are called increasing
(decreasing). By default, increasing candles are drawn in green
whereas decreasing are drawn in red.
close – Sets the close values.
closesrc – Sets the source reference on Chart Studio Cloud for
close.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
decreasing – plotly.graph_objects.candlestick.Decreasing
instance or dict with compatible properties
high – Sets the high values.
highsrc – Sets the source reference on Chart Studio Cloud for
high.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.candlestick.Hoverlabel
instance or dict with compatible properties
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
increasing – plotly.graph_objects.candlestick.Increasing
instance or dict with compatible properties
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.candlestick.Legendgrouptit
le instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.candlestick.Line instance
or dict with compatible properties
low – Sets the low values.
lowsrc – Sets the source reference on Chart Studio Cloud for
low.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
open – Sets the open values.
opensrc – Sets the source reference on Chart Studio Cloud for
open.
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.candlestick.Stream
instance or dict with compatible properties
text – Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
whiskerwidth – Sets the width of the whiskers relative to the box’ width. For example, with 1, the whiskers are as wide as the box(es).
x – Sets the x coordinates. If absent, linear coordinate will be generated.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_carpet(a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Carpet trace
The data describing carpet axis layout is set in y and
(optionally) also x. If only y is present, x the plot is
interpreted as a cheater plot and is filled in using the y
values. x and y may either be 2D arrays matching with each
dimension matching that of a and b, or they may be 1D
arrays with total length equal to that of a and b.
a – An array containing values of the first parameter value
a0 – Alternate to a. Builds a linear space of a
coordinates. Use with da where a0 is the starting
coordinate and da the step.
aaxis – plotly.graph_objects.carpet.Aaxis instance or
dict with compatible properties
asrc – Sets the source reference on Chart Studio Cloud for
a.
b – A two dimensional array of y coordinates at each carpet point.
b0 – Alternate to b. Builds a linear space of a
coordinates. Use with db where b0 is the starting
coordinate and db the step.
baxis – plotly.graph_objects.carpet.Baxis instance or
dict with compatible properties
bsrc – Sets the source reference on Chart Studio Cloud for
b.
carpet – An identifier for this carpet, so that scattercarpet
and contourcarpet traces can specify a carpet plot on
which they lie
cheaterslope – The shift applied to each successive row of data in
creating a cheater plot. Only used if x is been
omitted.
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.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
da – Sets the a coordinate step. See a0 for more info.
db – Sets the b coordinate step. See b0 for more info.
font – The default font used for axis & tick labels on this carpet
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.carpet.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
stream – plotly.graph_objects.carpet.Stream instance or
dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – A two dimensional array of y coordinates at each carpet point.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_choropleth(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Choropleth trace
The data that describes the choropleth value-to-color mapping
is set in z. The geographic locations corresponding to each
value in z are set in locations.
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.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choropleth.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
featureidkey – Sets the key in GeoJSON features which is used as id to
match the items included in the locations array. Only
has an effect when geojson is set. Support nested
property, for example “properties.name”.
geo – Sets a reference between this trace’s geospatial
coordinates and a geographic map. If “geo” (the default
value), the geospatial coordinates refer to
layout.geo. If “geo2”, the geospatial coordinates
refer to layout.geo2, and so on.
geojson – Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.choropleth.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.choropleth.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
locationmode – Determines the set of locations used to match entries
in locations to regions on the map. Values “ISO-3”,
“USA-states”, country names correspond to features on
the base map and value “geojson-id” corresponds to
features from a custom GeoJSON linked to the geojson
attribute.
locations – Sets the coordinates via location IDs or names. See
locationmode for more info.
locationssrc – Sets the source reference on Chart Studio Cloud for
locations.
marker – plotly.graph_objects.choropleth.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
selected – plotly.graph_objects.choropleth.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.choropleth.Stream
instance or dict with compatible properties
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.choropleth.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_choroplethmap(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Choroplethmap trace
GeoJSON features to be filled are set in geojson The data
that describes the choropleth value-to-color mapping is set in
locations and z.
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.
below – Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choroplethmap.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
featureidkey – Sets the key in GeoJSON features which is used as id to
match the items included in the locations array.
Support nested property, for example “properties.name”.
geojson – Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.choroplethmap.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable properties Anything contained in tag
<extra> is displayed in the secondary box, for
example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag
<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.choroplethmap.Legendgroupt
itle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
locations – Sets which features found in “geojson” to plot using
their feature id field.
locationssrc – Sets the source reference on Chart Studio Cloud for
locations.
marker – plotly.graph_objects.choroplethmap.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
selected – plotly.graph_objects.choroplethmap.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.choroplethmap.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a map subplot. If “map” (the default value), the
data refer to layout.map. If “map2”, the data refer
to layout.map2, and so on.
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.choroplethmap.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_choroplethmapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Choroplethmapbox trace
“choroplethmapbox” trace is deprecated! Please consider
switching to the “choroplethmap” trace type and map subplots.
Learn more at: https://plotly.com/python/maplibre-migration/ as
well as https://plotly.com/javascript/maplibre-migration/
GeoJSON features to be filled are set in geojson The data
that describes the choropleth value-to-color mapping is set in
locations and z.
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.
below – Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choroplethmapbox.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
featureidkey – Sets the key in GeoJSON features which is used as id to
match the items included in the locations array.
Support nested property, for example “properties.name”.
geojson – Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.choroplethmapbox.Hoverlabe
l instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable properties Anything contained in tag
<extra> is displayed in the secondary box, for
example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag
<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.choroplethmapbox.Legendgro
uptitle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
locations – Sets which features found in “geojson” to plot using
their feature id field.
locationssrc – Sets the source reference on Chart Studio Cloud for
locations.
marker – plotly.graph_objects.choroplethmapbox.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
selected – plotly.graph_objects.choroplethmapbox.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.choroplethmapbox.Stream
instance or dict with compatible properties
subplot – mapbox subplots and traces are deprecated! Please
consider switching to map subplots and traces. Learn
more at: https://plotly.com/python/maplibre-migration/
as well as https://plotly.com/javascript/maplibre-
migration/ Sets a reference between this trace’s data
coordinates and a mapbox subplot. If “mapbox” (the
default value), the data refer to layout.mapbox. If
“mapbox2”, the data refer to layout.mapbox2, and so
on.
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.choroplethmapbox.Unselecte
d instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_cone(anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Cone trace
Use cone traces to visualize vector fields. Specify a vector
field using 6 1D arrays, 3 position arrays x, y and z and
3 vector component arrays u, v, w. The cones are drawn
exactly at the positions given by x, y and z.
anchor – Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.
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.
cauto – Determines whether or not the color domain is computed
with respect to the input data (here u/v/w norm) or the
bounds set in cmin and cmax Defaults to false
when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as u/v/w norm and if set, cmin
must be set as well.
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 u/v/w norm. Has no
effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should
have the same units as u/v/w norm and if set, cmax
must be set as well.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.cone.ColorBar instance or
dict with compatible properties
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,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.cone.Hoverlabel instance
or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable norm Anything contained in tag <extra>
is displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.cone.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lighting – plotly.graph_objects.cone.Lighting instance or
dict with compatible properties
lightposition – plotly.graph_objects.cone.Lightposition
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
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.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
sizemode – Determines whether sizeref is set as a “scaled” (i.e
unitless) scalar (normalized by the max u/v/w norm in
the vector field) or as “absolute” value (in the same
units as the vector field). To display sizes in actual
vector length use “raw”.
sizeref – Adjusts the cone size scaling. The size of the cones is
determined by their u/v/w norm multiplied a factor and
sizeref. This factor (computed internally)
corresponds to the minimum “time” to travel across two
successive x/y/z positions at the average velocity of
those two successive positions. All cones in a given
trace use the same factor. With sizemode set to
“raw”, its default value is 1. With sizemode set to
“scaled”, sizeref is unitless, its default value is
0.5. With sizemode set to “absolute”, sizeref has
the same units as the u/v/w vector field, its the
default value is half the sample’s maximum vector norm.
stream – plotly.graph_objects.cone.Stream instance or
dict with compatible properties
text – Sets the text elements associated with the cones. If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
u – Sets the x components of the vector field.
uhoverformat – Sets the hover text formatting rulefor u using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
usrc – Sets the source reference on Chart Studio Cloud for
u.
v – Sets the y components of the vector field.
vhoverformat – Sets the hover text formatting rulefor v using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
vsrc – Sets the source reference on Chart Studio Cloud for
v.
w – Sets the z components of the vector field.
whoverformat – Sets the hover text formatting rulefor w using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
wsrc – Sets the source reference on Chart Studio Cloud for
w.
x – Sets the x coordinates of the vector field and of the displayed cones.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates of the vector field and of the displayed cones.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the z coordinates of the vector field and of the displayed cones.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_contour(autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Contour trace
The data from which contour lines are computed is set in z.
Data in z must be a 2D list of numbers. Say that z has N
rows and M columns, then by default, these N rows correspond to
N y coordinates (set in y or auto-generated) and the M
columns correspond to M x coordinates (set in x or auto-
generated). By setting transpose to True, the above behavior
is flipped.
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.
autocontour – Determines whether or not the contour level attributes
are picked by an algorithm. If True, the number of
contour levels can be set in ncontours. If False, set
the contour level attributes in contours.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.contour.ColorBar instance
or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing
values) in the z data are filled in. It is defaulted
to true if z is a one dimensional array otherwise it
is defaulted to false.
contours – plotly.graph_objects.contour.Contours instance
or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
fillcolor – Sets the fill color if contours.type is “constraint”.
Defaults to a half-transparent variant of the line
color, marker color, or marker line color, whichever is
available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.contour.Hoverlabel
instance or dict with compatible properties
hoverongaps – Determines whether or not gaps (i.e. {nan} or missing
values) in the z data have hover labels associated
with them.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.contour.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.contour.Line instance or
dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
ncontours – Sets the maximum number of contour levels. The actual
number of contours will be chosen automatically to be
less than or equal to the value of ncontours. Has an
effect only if autocontour is True or if
contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.contour.Stream instance
or dict with compatible properties
text – Sets the text elements associated with each z value.
textfont – For this trace it only has an effect if coloring is
set to “heatmap”. Sets the text font.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – For this trace it only has an effect if coloring is
set to “heatmap”. Template string used for rendering
the information text that appear on points. Note that
this will override textinfo. Variables are inserted
using %{variable}, for example “y: %{y}”. Numbers are
formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables x, y, z and text.
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
xtype – If “array”, the heatmap’s x coordinates are given by
“x” (the default behavior when x is provided). If
“scaled”, the heatmap’s x coordinates are given by “x0”
and “dx” (the default behavior when x is not
provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
ytype – If “array”, the heatmap’s y coordinates are given by
“y” (the default behavior when y is provided) If
“scaled”, the heatmap’s y coordinates are given by “y0”
and “dy” (the default behavior when y is not
provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rulefor z using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_contourcarpet(a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Contourcarpet trace
Plots contours on either the first carpet axis or the carpet
axis with a matching carpet attribute. Data z is
interpreted as matching that of the corresponding carpet axis.
a – Sets the x coordinates.
a0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
asrc – Sets the source reference on Chart Studio Cloud for
a.
atype – If “array”, the heatmap’s x coordinates are given by
“x” (the default behavior when x is provided). If
“scaled”, the heatmap’s x coordinates are given by “x0”
and “dx” (the default behavior when x is not
provided).
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.
autocontour – Determines whether or not the contour level attributes
are picked by an algorithm. If True, the number of
contour levels can be set in ncontours. If False, set
the contour level attributes in contours.
b – Sets the y coordinates.
b0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
bsrc – Sets the source reference on Chart Studio Cloud for
b.
btype – If “array”, the heatmap’s y coordinates are given by
“y” (the default behavior when y is provided) If
“scaled”, the heatmap’s y coordinates are given by “y0”
and “dy” (the default behavior when y is not
provided)
carpet – The carpet of the carpet axes on which this contour
trace lies
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.contourcarpet.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
contours – plotly.graph_objects.contourcarpet.Contours
instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
da – Sets the x coordinate step. See x0 for more info.
db – Sets the y coordinate step. See y0 for more info.
fillcolor – Sets the fill color if contours.type is “constraint”.
Defaults to a half-transparent variant of the line
color, marker color, or marker line color, whichever is
available.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.contourcarpet.Legendgroupt
itle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.contourcarpet.Line
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
ncontours – Sets the maximum number of contour levels. The actual
number of contours will be chosen automatically to be
less than or equal to the value of ncontours. Has an
effect only if autocontour is True or if
contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.contourcarpet.Stream
instance or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
z – Sets the z data.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_densitymap(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Densitymap trace
Draws a bivariate kernel density estimation with a Gaussian
kernel from lon and lat coordinates and optional z values
using a colorscale.
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.
below – Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.densitymap.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.densitymap.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (lon,lat)
pair If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (lon,lat)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for
lat.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.densitymap.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for
lon.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
radius – Sets the radius of influence of one lon / lat point
in pixels. Increasing the value makes the densitymap
trace smoother, but less detailed.
radiussrc – Sets the source reference on Chart Studio Cloud for
radius.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.densitymap.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a map subplot. If “map” (the default value), the
data refer to layout.map. If “map2”, the data refer
to layout.map2, and so on.
text – Sets text elements associated with each (lon,lat) pair
If a single string, the same string appears over all
the data points. If an array of string, the items are
mapped in order to the this trace’s (lon,lat)
coordinates. If trace hoverinfo contains a “text”
flag and “hovertext” is not set, these elements will be
seen in the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
z – Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_densitymapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Densitymapbox trace
“densitymapbox” trace is deprecated! Please consider switching
to the “densitymap” trace type and map subplots. Learn more
at: https://plotly.com/python/maplibre-migration/ as well as
https://plotly.com/javascript/maplibre-migration/ Draws a
bivariate kernel density estimation with a Gaussian kernel from
lon and lat coordinates and optional z values using a
colorscale.
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.
below – Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.densitymapbox.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.densitymapbox.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (lon,lat)
pair If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (lon,lat)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for
lat.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.densitymapbox.Legendgroupt
itle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for
lon.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
radius – Sets the radius of influence of one lon / lat point
in pixels. Increasing the value makes the densitymapbox
trace smoother, but less detailed.
radiussrc – Sets the source reference on Chart Studio Cloud for
radius.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.densitymapbox.Stream
instance or dict with compatible properties
subplot – mapbox subplots and traces are deprecated! Please
consider switching to map subplots and traces. Learn
more at: https://plotly.com/python/maplibre-migration/
as well as https://plotly.com/javascript/maplibre-
migration/ Sets a reference between this trace’s data
coordinates and a mapbox subplot. If “mapbox” (the
default value), the data refer to layout.mapbox. If
“mapbox2”, the data refer to layout.mapbox2, and so
on.
text – Sets text elements associated with each (lon,lat) pair
If a single string, the same string appears over all
the data points. If an array of string, the items are
mapped in order to the this trace’s (lon,lat)
coordinates. If trace hoverinfo contains a “text”
flag and “hovertext” is not set, these elements will be
seen in the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
z – Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_funnel(alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Funnel trace
Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a “drop-off” representation wherein each item appears in each stage it traversed. See also the “funnelarea” trace type for a different approach to visualizing funnel data.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
cliponaxis – Determines whether the text nodes are clipped about the
subplot axes. To show the text nodes above axis lines
and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
connector – plotly.graph_objects.funnel.Connector instance
or dict with compatible properties
constraintext – Constrain the size of text inside or outside a bar to be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.funnel.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables percentInitial, percentPrevious and
percentTotal. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextanchor – Determines if texts are kept at center or start/end
points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.funnel.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.funnel.Marker instance or
dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the funnels. With “v” (“h”), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only “y” array is presented or orientation is set to “v”. Also regarding graphs including only ‘horizontal’ funnels, “autorange” on the “y-axis” are set to “reversed”.
outsidetextfont – Sets the font used for text lying outside the bar.
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.funnel.Stream instance or
dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textangle – Sets the angle of the tick labels with respect to the
bar. For example, a tickangle of -90 draws the tick
labels vertically. With “auto” the texts may
automatically be rotated to fit with the maximum size
in bars.
textfont – Sets the font used for text.
textinfo – Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).
textposition – Specifies the location of the text. “inside”
positions text inside, next to the bar end (rotated
and scaled if needed). “outside” positions text
outside, next to the bar end (scaled if needed), unless
there is another bar stacked on this one, then the text
gets pushed inside. “auto” tries to position text
inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If
“none”, no text appears.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables percentInitial, percentPrevious,
percentTotal, label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
width – Sets the bar width (in position axis units).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_funnelarea(aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Funnelarea trace
Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a “pie” trace, wherein each item appears in a single stage. See also the “funnel” trace type for a different approach to visualizing funnel data.
aspectratio – Sets the ratio between height and width
baseratio – Sets the ratio between bottom length and maximum top length.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.funnelarea.Domain
instance or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.funnelarea.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label, color, value, text and
percent. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each sector.
If a single string, the same string appears for all
data points. If an array of string, the items are
mapped in order of this trace’s sectors. To be seen,
trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextfont – Sets the font used for textinfo lying inside the
sector.
label0 – Alternate to labels. Builds a numeric set of labels.
Use with dlabel where label0 is the starting label
and dlabel the step.
labels – Sets the sector labels. If labels entries are
duplicated, we sum associated values or simply count
occurrences if values is not provided. For other
array attributes (including color) we use the first
non-empty entry among all occurrences of the label.
labelssrc – Sets the source reference on Chart Studio Cloud for
labels.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.funnelarea.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.funnelarea.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
scalegroup – If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.funnelarea.Stream
instance or dict with compatible properties
text – Sets text elements associated with each sector. If
trace textinfo contains a “text” flag, these elements
will be seen on the chart. If trace hoverinfo
contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Specifies the location of the textinfo.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label, color, value, text and
percent.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
title – plotly.graph_objects.funnelarea.Title instance
or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
values – Sets the values of the sectors. If omitted, we count occurrences of each label.
valuessrc – Sets the source reference on Chart Studio Cloud for
values.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_heatmap(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Heatmap trace
The data that describes the heatmap value-to-color mapping is
set in z. Data in z can either be a 2D list of values
(ragged or not) or a 1D array of values. In the case where z
is a 2D list, say that z has N rows and M columns. Then, by
default, the resulting heatmap will have N partitions along the
y axis and M partitions along the x axis. In other words, the
i-th row/ j-th column cell in z is mapped to the i-th
partition of the y axis (starting from the bottom of the plot)
and the j-th partition of the x-axis (starting from the left of
the plot). This behavior can be flipped by using transpose.
Moreover, x (y) can be provided with M or M+1 (N or N+1)
elements. If M (N), then the coordinates correspond to the
center of the heatmap cells and the cells have equal width. If
M+1 (N+1), then the coordinates correspond to the edges of the
heatmap cells. In the case where z is a 1D list, the x and y
coordinates must be provided in x and y respectively to
form data triplets.
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.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.heatmap.ColorBar instance
or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing
values) in the z data are filled in. It is defaulted
to true if z is a one dimensional array and zsmooth
is not false; otherwise it is defaulted to false.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.heatmap.Hoverlabel
instance or dict with compatible properties
hoverongaps – Determines whether or not gaps (i.e. {nan} or missing
values) in the z data have hover labels associated
with them.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.heatmap.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.heatmap.Stream instance
or dict with compatible properties
text – Sets the text elements associated with each z value.
textfont – Sets the text font.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables x, y, z and text.
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xgap – Sets the horizontal gap (in pixels) between bricks.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
xtype – If “array”, the heatmap’s x coordinates are given by
“x” (the default behavior when x is provided). If
“scaled”, the heatmap’s x coordinates are given by “x0”
and “dx” (the default behavior when x is not
provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ygap – Sets the vertical gap (in pixels) between bricks.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
ytype – If “array”, the heatmap’s y coordinates are given by
“y” (the default behavior when y is provided) If
“scaled”, the heatmap’s y coordinates are given by “y0”
and “dy” (the default behavior when y is not
provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rulefor z using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
zsmooth – Picks a smoothing algorithm use to smooth z data.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_histogram(alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Histogram trace
The sample data from which statistics are computed is set in
x for vertically spanning histograms and in y for
horizontally spanning histograms. Binning options are set
xbins and ybins respectively if no aggregation data is
provided.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
autobinx – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobinx is not needed.
However, we accept autobinx: true or false and will
update xbins accordingly before deleting autobinx
from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobiny is not needed.
However, we accept autobiny: true or false and will
update ybins accordingly before deleting autobiny
from the trace.
bingroup – Set a group of histogram traces which will have
compatible bin settings. Note that traces on the same
subplot and with the same “orientation” under barmode
“stack”, “relative” and “group” are forced into the
same bingroup, Using bingroup, traces under barmode
“overlay” and on different axes (of the same axis type)
can have compatible bin settings. Note that histogram
and histogram2d* trace can share the same bingroup
cliponaxis – Determines whether the text nodes are clipped about the
subplot axes. To show the text nodes above axis lines
and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
constraintext – Constrain the size of text inside or outside a bar to be no larger than the bar itself.
cumulative – plotly.graph_objects.histogram.Cumulative
instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
error_x – plotly.graph_objects.histogram.ErrorX instance
or dict with compatible properties
error_y – plotly.graph_objects.histogram.ErrorY instance
or dict with compatible properties
histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.histogram.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable binNumber Anything contained in tag
<extra> is displayed in the secondary box, for
example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag
<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextanchor – Determines if texts are kept at center or start/end
points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – :class:`plotly.graph_objects.histogram.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.histogram.Marker instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
ybins.size is provided.
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
selected – plotly.graph_objects.histogram.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.histogram.Stream instance
or dict with compatible properties
text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.
textangle – Sets the angle of the tick labels with respect to the
bar. For example, a tickangle of -90 draws the tick
labels vertically. With “auto” the texts may
automatically be rotated to fit with the maximum size
in bars.
textfont – Sets the text font.
textposition – Specifies the location of the text. “inside”
positions text inside, next to the bar end (rotated
and scaled if needed). “outside” positions text
outside, next to the bar end (scaled if needed), unless
there is another bar stacked on this one, then the text
gets pushed inside. “auto” tries to position text
inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If
“none”, no text appears.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label and value.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.histogram.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xbins – plotly.graph_objects.histogram.XBins instance
or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ybins – plotly.graph_objects.histogram.YBins instance
or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_histogram2d(autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Histogram2d trace
The sample data from which statistics are computed is set in
x and y (where x and y represent marginal
distributions, binning is set in xbins and ybins in this
case) or z (where z represent the 2D distribution and
binning set, binning is set by x and y in this case). The
resulting distribution is visualized as a heatmap.
autobinx – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobinx is not needed.
However, we accept autobinx: true or false and will
update xbins accordingly before deleting autobinx
from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobiny is not needed.
However, we accept autobiny: true or false and will
update ybins accordingly before deleting autobiny
from the trace.
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.
bingroup – Set the xbingroup and ybingroup default prefix For
example, setting a bingroup of 1 on two histogram2d
traces will make them their x-bins and y-bins match
separately.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.histogram2d.ColorBar
instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.histogram2d.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable z Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.histogram2d.Legendgrouptit
le instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.histogram2d.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
ybins.size is provided.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.histogram2d.Stream
instance or dict with compatible properties
textfont – Sets the text font.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable z
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xbingroup – Set a group of histogram traces which will have
compatible x-bin settings. Using xbingroup,
histogram2d and histogram2dcontour traces (on axes of
the same axis type) can have compatible x-bin settings.
Note that the same xbingroup value can be used to set
(1D) histogram bingroup
xbins – plotly.graph_objects.histogram2d.XBins
instance or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xgap – Sets the horizontal gap (in pixels) between bricks.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ybingroup – Set a group of histogram traces which will have
compatible y-bin settings. Using ybingroup,
histogram2d and histogram2dcontour traces (on axes of
the same axis type) can have compatible y-bin settings.
Note that the same ybingroup value can be used to set
(1D) histogram bingroup
ybins – plotly.graph_objects.histogram2d.YBins
instance or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ygap – Sets the vertical gap (in pixels) between bricks.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the aggregation data.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rulefor z using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsmooth – Picks a smoothing algorithm use to smooth z data.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_histogram2dcontour(autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Histogram2dContour trace
The sample data from which statistics are computed is set in
x and y (where x and y represent marginal
distributions, binning is set in xbins and ybins in this
case) or z (where z represent the 2D distribution and
binning set, binning is set by x and y in this case). The
resulting distribution is visualized as a contour plot.
autobinx – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobinx is not needed.
However, we accept autobinx: true or false and will
update xbins accordingly before deleting autobinx
from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto-
determined separately and autobiny is not needed.
However, we accept autobiny: true or false and will
update ybins accordingly before deleting autobiny
from the trace.
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.
autocontour – Determines whether or not the contour level attributes
are picked by an algorithm. If True, the number of
contour levels can be set in ncontours. If False, set
the contour level attributes in contours.
bingroup – Set the xbingroup and ybingroup default prefix For
example, setting a bingroup of 1 on two histogram2d
traces will make them their x-bins and y-bins match
separately.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.histogram2dcontour.ColorBa
r instance or dict with compatible properties
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 zmin and zmax.
Alternatively, colorscale may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
contours – plotly.graph_objects.histogram2dcontour.Contour
s instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.histogram2dcontour.Hoverla
bel instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variable z Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.histogram2dcontour.Legendg
rouptitle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.histogram2dcontour.Line
instance or dict with compatible properties
marker – plotly.graph_objects.histogram2dcontour.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
ybins.size is provided.
ncontours – Sets the maximum number of contour levels. The actual
number of contours will be chosen automatically to be
less than or equal to the value of ncontours. Has an
effect only if autocontour is True or if
contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin
will correspond to the last color in the array and
zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.histogram2dcontour.Stream
instance or dict with compatible properties
textfont – For this trace it only has an effect if coloring is
set to “heatmap”. Sets the text font.
texttemplate – For this trace it only has an effect if coloring is
set to “heatmap”. Template string used for rendering
the information text that appear on points. Note that
this will override textinfo. Variables are inserted
using %{variable}, for example “y: %{y}”. Numbers are
formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables x, y, z and text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xbingroup – Set a group of histogram traces which will have
compatible x-bin settings. Using xbingroup,
histogram2d and histogram2dcontour traces (on axes of
the same axis type) can have compatible x-bin settings.
Note that the same xbingroup value can be used to set
(1D) histogram bingroup
xbins – plotly.graph_objects.histogram2dcontour.XBins
instance or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ybingroup – Set a group of histogram traces which will have
compatible y-bin settings. Using ybingroup,
histogram2d and histogram2dcontour traces (on axes of
the same axis type) can have compatible y-bin settings.
Note that the same ybingroup value can be used to set
(1D) histogram bingroup
ybins – plotly.graph_objects.histogram2dcontour.YBins
instance or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the aggregation data.
zauto – Determines whether or not the color domain is computed
with respect to the input data (here in z) or the
bounds set in zmin and zmax Defaults to false
when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rulefor z using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
zmax – Sets the upper bound of the color domain. Value should
have the same units as in z and if set, zmin must
be set as well.
zmid – Sets the mid-point of the color domain by scaling
zmin and/or zmax to be equidistant to this point.
Value should have the same units as in z. Has no
effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should
have the same units as in z and if set, zmax must
be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_hline(y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a horizontal line to a plot or subplot that extends infinitely in the x-dimension.
y (float or int) – A number representing the y coordinate of the horizontal line.
exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.
row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.
annotation_position (a string containing optionally ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the line. Example positions are “bottom left”, “right top”, “right”, “bottom”. If an annotation is added but annotation_position is not specified, this defaults to “top right”.
annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.
**kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.
add_hrect(y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a rectangle to a plot or subplot that extends infinitely in the x-dimension.
y0 (float or int) – A number representing the y coordinate of one side of the rectangle.
y1 (float or int) – A number representing the y coordinate of the other side of the rectangle.
exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.
row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.
annotation_position (a string containing optionally ["inside", "outside"], ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the rectangle. Example positions are “outside top left”, “inside bottom”, “right”, “inside left”, “inside” (“outside” is not supported). If an annotation is added but annotation_position is not specified this defaults to “inside top right”.
annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.
**kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.
add_icicle(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Icicle trace
Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The icicle sectors are determined by the entries in “labels” or “ids” and in “parents”.
branchvalues – Determines how the items in values are summed. When
set to “total”, items in values are taken to be value
of all its descendants. When set to “remainder”, items
in values corresponding to the root and the branches
sectors are taken to be the extra part not part of the
sum of the values at their leaves.
count – Determines default for values when it is not
provided, by inferring a 1 for each of the “leaves”
and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
domain – plotly.graph_objects.icicle.Domain instance or
dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.icicle.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables currentPath, root, entry,
percentRoot, percentEntry and percentParent.
Anything contained in tag <extra> is displayed in the
secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each sector.
If a single string, the same string appears for all
data points. If an array of string, the items are
mapped in order of this trace’s sectors. To be seen,
trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextfont – Sets the font used for textinfo lying inside the
sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for
labels.
leaf – plotly.graph_objects.icicle.Leaf instance or
dict with compatible properties
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.icicle.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
level – Sets the level from which this trace hierarchy is
rendered. Set level to '' to start from the root
node in the hierarchy. Must be an “id” if ids is
filled in, otherwise plotly attempts to find a matching
item in labels.
marker – plotly.graph_objects.icicle.Marker instance or
dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given
level. Set maxdepth to “-1” to render all the
levels in the hierarchy.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the
sector. This option refers to the root of the hierarchy
presented on top left corner of a treemap graph. Please
note that if a hierarchy has multiple root nodes, this
option won’t have any effect and insidetextfont would
be used.
parents – Sets the parent sectors for each of the sectors. Empty
string items ‘’ are understood to reference the root
node in the hierarchy. If ids is filled, parents
items are understood to be “ids” themselves. When ids
is not set, plotly attempts to find matching items in
labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for
parents.
pathbar – plotly.graph_objects.icicle.Pathbar instance
or dict with compatible properties
root – plotly.graph_objects.icicle.Root instance or
dict with compatible properties
sort – Determines whether or not the sectors are reordered from largest to smallest.
stream – plotly.graph_objects.icicle.Stream instance or
dict with compatible properties
text – Sets text elements associated with each sector. If
trace textinfo contains a “text” flag, these elements
will be seen on the chart. If trace hoverinfo
contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Sets the positions of the text elements.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables currentPath, root, entry,
percentRoot, percentEntry, percentParent, label
and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
tiling – plotly.graph_objects.icicle.Tiling instance or
dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
values – Sets the values associated with each of the sectors.
Use with branchvalues to determine how the values are
summed.
valuessrc – Sets the source reference on Chart Studio Cloud for
values.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_image(colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Image trace
Display an image, i.e. data on a 2D regular raster. By default,
when an image is displayed in a subplot, its y axis will be
reversed (ie. autorange: 'reversed'), constrained to the
domain (ie. constrain: 'domain') and it will have the same
scale as its x axis (ie. scaleanchor: 'x,) in order for
pixels to be rendered as squares.
colormodel – Color model used to map the numerical color components
described in z into colors. If source is specified,
this attribute will be set to rgba256 otherwise it
defaults to rgb.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Set the pixel’s horizontal size.
dy – Set the pixel’s vertical size
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.image.Hoverlabel instance
or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables z, color and colormodel. Anything
contained in tag <extra> is displayed in the
secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.image.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
source – Specifies the data URI of the image to be visualized. The URI consists of “data:image/[<media subtype>][;base64],<data>”
stream – plotly.graph_objects.image.Stream instance or
dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x0 – Set the image’s x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
y0 – Set the image’s y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
z – A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.
zmax – Array defining the higher bound for each color
component. Note that the default value will depend on
the colormodel. For the rgb colormodel, it is [255,
255, 255]. For the rgba colormodel, it is [255, 255,
255, 1]. For the rgba256 colormodel, it is [255, 255,
255, 255]. For the hsl colormodel, it is [360, 100,
100]. For the hsla colormodel, it is [360, 100, 100,
1].
zmin – Array defining the lower bound for each color
component. Note that the default value will depend on
the colormodel. For the rgb colormodel, it is [0, 0,
0]. For the rgba colormodel, it is [0, 0, 0, 0]. For
the rgba256 colormodel, it is [0, 0, 0, 0]. For the
hsl colormodel, it is [0, 0, 0]. For the hsla
colormodel, it is [0, 0, 0, 0].
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
zsmooth – Picks a smoothing algorithm used to smooth z data.
This only applies for image traces that use the
source attribute.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_indicator(align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Indicator trace
An indicator is used to visualize a single value along with
some contextual information such as steps or a threshold,
using a combination of three visual elements: a number, a
delta, and/or a gauge. Deltas are taken with respect to a
reference. Gauges can be either angular or bullet (aka
linear) gauges.
align – Sets the horizontal alignment of the text within the
box. Note that this attribute has no effect if an
angular gauge is displayed: in this case, it is always
centered
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
delta – plotly.graph_objects.indicator.Delta instance
or dict with compatible properties
domain – plotly.graph_objects.indicator.Domain instance
or dict with compatible properties
gauge – The gauge of the Indicator plot.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – :class:`plotly.graph_objects.indicator.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines how the value is displayed on the graph.
number displays the value numerically in text.
delta displays the difference to a reference value in
text. Finally, gauge displays the value graphically
on an axis.
name – Sets the trace name. The trace name appears as the legend item and on hover.
number – plotly.graph_objects.indicator.Number instance
or dict with compatible properties
stream – plotly.graph_objects.indicator.Stream instance
or dict with compatible properties
title – plotly.graph_objects.indicator.Title instance
or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
value – Sets the number to be displayed.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_isosurface(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Isosurface trace
Draws isosurfaces between iso-min and iso-max values with
coordinates given by four 1-dimensional arrays containing the
value, x, y and z of every vertex of a uniform or non-
uniform 3-D grid. Horizontal or vertical slices, caps as well
as spaceframe between iso-min and iso-max values could also be
drawn using this trace.
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.
caps – plotly.graph_objects.isosurface.Caps instance
or dict with compatible properties
cauto – Determines whether or not the color domain is computed
with respect to the input data (here value) or the
bounds set in cmin and cmax Defaults to false
when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as value and if set, cmin must
be set as well.
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 value. Has no
effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should
have the same units as value and if set, cmax must
be set as well.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.isosurface.ColorBar
instance or dict with compatible properties
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,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
contour – plotly.graph_objects.isosurface.Contour
instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.isosurface.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.isosurface.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lighting – plotly.graph_objects.isosurface.Lighting
instance or dict with compatible properties
lightposition – plotly.graph_objects.isosurface.Lightposition
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
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.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
slices – plotly.graph_objects.isosurface.Slices
instance or dict with compatible properties
spaceframe – plotly.graph_objects.isosurface.Spaceframe
instance or dict with compatible properties
stream – plotly.graph_objects.isosurface.Stream
instance or dict with compatible properties
surface – plotly.graph_objects.isosurface.Surface
instance or dict with compatible properties
text – Sets the text elements associated with the vertices. If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
value – Sets the 4th dimension (value) of the vertices.
valuehoverformat – Sets the hover text formatting rulefor value using
d3 formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
valuesrc – Sets the source reference on Chart Studio Cloud for
value.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the X coordinates of the vertices on X axis.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the Y coordinates of the vertices on Y axis.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the Z coordinates of the vertices on Z axis.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_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, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure¶Create and add a new image to the figure’s layout
arg – instance of Image or dict with compatible properties
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.
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.
opacity – Sets the opacity of the image.
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.
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.
sizing – Specifies which dimension of the image to constrain.
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.
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.
visible – Determines whether or not this image is visible.
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
xanchor – Sets the anchor for the x position
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.
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
yanchor – Sets the anchor for the y position.
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.
row – Subplot row for image. If ‘all’, addresses all rows in the specified column(s).
col – Subplot column for image. If ‘all’, addresses all columns in the specified row(s).
secondary_y – Whether to add image to secondary y-axis
exclude_empty_subplots – If True, image will not be added to subplots without traces.
add_mesh3d(alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Mesh3d trace
Draws sets of triangles with coordinates given by three
1-dimensional arrays in x, y, z and (1) a sets of i,
j, k indices (2) Delaunay triangulation or (3) the Alpha-
shape algorithm or (4) the Convex-hull algorithm
alphahull – Determines how the mesh surface triangles are derived
from the set of vertices (points) represented by the
x, y and z arrays, if the i, j, k arrays
are not supplied. For general use of mesh3d it is
preferred that i, j, k are supplied. If “-1”,
Delaunay triangulation is used, which is mainly
suitable if the mesh is a single, more or less layer
surface that is perpendicular to delaunayaxis. In
case the delaunayaxis intersects the mesh surface at
more than one point it will result triangles that are
very long in the dimension of delaunayaxis. If “>0”,
the alpha-shape algorithm is used. In this case, the
positive alphahull value signals the use of the
alpha-shape algorithm, _and_ its value acts as the
parameter for the mesh fitting. If 0, the convex-hull
algorithm is used. It is suitable for convex bodies or
if the intention is to enclose the x, y and z
point set into a convex hull.
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.
cauto – Determines whether or not the color domain is computed
with respect to the input data (here intensity) or
the bounds set in cmin and cmax Defaults to false
when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as intensity and if set, cmin
must be set as well.
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 intensity. Has no
effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should
have the same units as intensity and if set, cmax
must be set as well.
color – Sets the color of the whole mesh
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.mesh3d.ColorBar instance
or dict with compatible properties
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,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
contour – plotly.graph_objects.mesh3d.Contour instance
or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
delaunayaxis – Sets the Delaunay axis, which is the axis that is
perpendicular to the surface of the Delaunay
triangulation. It has an effect if i, j, k are
not provided and alphahull is set to indicate
Delaunay triangulation.
facecolor – Sets the color of each face Overrides “color” and “vertexcolor”.
facecolorsrc – Sets the source reference on Chart Studio Cloud for
facecolor.
flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.mesh3d.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
i – A vector of vertex indices, i.e. integer values between
0 and the length of the vertex vectors, representing
the “first” vertex of a triangle. For example, {i[m],
j[m], k[m]} together represent face m (triangle m) in
the mesh, where i[m] = n points to the triplet
{x[n], y[n], z[n]} in the vertex arrays. Therefore,
each element in i represents a point in space, which
is the first vertex of a triangle.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
intensity – Sets the intensity values for vertices or cells as
defined by intensitymode. It can be used for plotting
fields on meshes.
intensitymode – Determines the source of intensity values.
intensitysrc – Sets the source reference on Chart Studio Cloud for
intensity.
isrc – Sets the source reference on Chart Studio Cloud for
i.
j – A vector of vertex indices, i.e. integer values between
0 and the length of the vertex vectors, representing
the “second” vertex of a triangle. For example, {i[m],
j[m], k[m]} together represent face m (triangle m) in
the mesh, where j[m] = n points to the triplet
{x[n], y[n], z[n]} in the vertex arrays. Therefore,
each element in j represents a point in space, which
is the second vertex of a triangle.
jsrc – Sets the source reference on Chart Studio Cloud for
j.
k – A vector of vertex indices, i.e. integer values between
0 and the length of the vertex vectors, representing
the “third” vertex of a triangle. For example, {i[m],
j[m], k[m]} together represent face m (triangle m) in
the mesh, where k[m] = n points to the triplet
{x[n], y[n], z[n]} in the vertex arrays. Therefore,
each element in k represents a point in space, which
is the third vertex of a triangle.
ksrc – Sets the source reference on Chart Studio Cloud for
k.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.mesh3d.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lighting – plotly.graph_objects.mesh3d.Lighting instance
or dict with compatible properties
lightposition – plotly.graph_objects.mesh3d.Lightposition
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
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.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.mesh3d.Stream instance or
dict with compatible properties
text – Sets the text elements associated with the vertices. If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
vertexcolor – Sets the color of each vertex Overrides “color”. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.
vertexcolorsrc – Sets the source reference on Chart Studio Cloud for
vertexcolor.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the X coordinates of the vertices. The nth element
of vectors x, y and z jointly represent the X, Y
and Z coordinates of the nth vertex.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the Y coordinates of the vertices. The nth element
of vectors x, y and z jointly represent the X, Y
and Z coordinates of the nth vertex.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the Z coordinates of the vertices. The nth element
of vectors x, y and z jointly represent the X, Y
and Z coordinates of the nth vertex.
zcalendar – Sets the calendar system to use with z date data.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_ohlc(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Ohlc trace
The ohlc (short for Open-High-Low-Close) is a style of
financial chart describing open, high, low and close for a
given x coordinate (most likely time). The tip of the lines
represent the low and high values and the horizontal
segments represent the open and close values. Sample points
where the close value is higher (lower) then the open value are
called increasing (decreasing). By default, increasing items
are drawn in green whereas decreasing are drawn in red.
close – Sets the close values.
closesrc – Sets the source reference on Chart Studio Cloud for
close.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
decreasing – plotly.graph_objects.ohlc.Decreasing instance
or dict with compatible properties
high – Sets the high values.
highsrc – Sets the source reference on Chart Studio Cloud for
high.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.ohlc.Hoverlabel instance
or dict with compatible properties
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
increasing – plotly.graph_objects.ohlc.Increasing instance
or dict with compatible properties
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.ohlc.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.ohlc.Line instance or
dict with compatible properties
low – Sets the low values.
lowsrc – Sets the source reference on Chart Studio Cloud for
low.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
open – Sets the open values.
opensrc – Sets the source reference on Chart Studio Cloud for
open.
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.ohlc.Stream instance or
dict with compatible properties
text – Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
tickwidth – Sets the width of the open/close tick marks relative to the “x” minimal interval.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates. If absent, linear coordinate will be generated.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_parcats(arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Parcats trace
Parallel categories diagram for multidimensional categorical data.
arrangement – Sets the drag interaction mode for categories and
dimensions. If perpendicular, the categories can only
move along a line perpendicular to the paths. If
freeform, the categories can freely move on the
plane. If fixed, the categories and dimensions are
stationary.
bundlecolors – Sort paths so that like colors are bundled together within each category.
counts – The number of observations represented by each state. Defaults to 1 so that each state represents one observation
countssrc – Sets the source reference on Chart Studio Cloud for
counts.
dimensions – The dimensions (variables) of the parallel categories diagram.
dimensiondefaults – When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions
domain – plotly.graph_objects.parcats.Domain instance
or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoveron – Sets the hover interaction mode for the parcats
diagram. If category, hover interaction take place
per category. If color, hover interactions take place
per color per category. If dimension, hover
interactions take place across all categories per
dimension.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. This value here applies when hovering
over dimensions. Note that *categorycount,
“colorcount” and “bandcolorcount” are only available
when hoveron contains the “color” flagFinally, the
template string has access to variables count,
probability, category, categorycount,
colorcount and bandcolorcount. Anything contained
in tag <extra> is displayed in the secondary box, for
example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag
<extra></extra>.
labelfont – Sets the font for the dimension labels.
legendgrouptitle – plotly.graph_objects.parcats.Legendgrouptitle
instance or dict with compatible properties
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.parcats.Line instance or
dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
sortpaths – Sets the path sorting algorithm. If forward, sort
paths based on dimension categories from left to right.
If backward, sort paths based on dimensions
categories from right to left.
stream – plotly.graph_objects.parcats.Stream instance
or dict with compatible properties
tickfont – Sets the font for the category labels.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_parcoords(customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Parcoords trace
Parallel coordinates for multidimensional exploratory data
analysis. The samples are specified in dimensions. The colors
are set in line.color.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dimensions – The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.
dimensiondefaults – When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions
domain – plotly.graph_objects.parcoords.Domain instance
or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
labelangle – Sets the angle of the labels with respect to the
horizontal. For example, a tickangle of -90 draws the
labels vertically. Tilted labels with “labelangle” may
be positioned better inside margins when
labelposition is set to “bottom”.
labelfont – Sets the font for the dimension labels.
labelside – Specifies the location of the label. “top” positions
labels above, next to the title “bottom” positions
labels below the graph Tilted labels with “labelangle”
may be positioned better inside margins when
labelposition is set to “bottom”.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – :class:`plotly.graph_objects.parcoords.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.parcoords.Line instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
rangefont – Sets the font for the dimension range values.
stream – plotly.graph_objects.parcoords.Stream instance
or dict with compatible properties
tickfont – Sets the font for the dimension tick values.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.parcoords.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_pie(automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Pie trace
A data visualized by the sectors of the pie is set in values.
The sector labels are set in labels. The sector colors are
set in marker.colors
automargin – Determines whether outside text labels can push the margins.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
direction – Specifies the direction at which succeeding sectors follow one another.
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.pie.Domain instance or
dict with compatible properties
hole – Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.pie.Hoverlabel instance
or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label, color, value, percent and
text. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each sector.
If a single string, the same string appears for all
data points. If an array of string, the items are
mapped in order of this trace’s sectors. To be seen,
trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextfont – Sets the font used for textinfo lying inside the
sector.
insidetextorientation – Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.
label0 – Alternate to labels. Builds a numeric set of labels.
Use with dlabel where label0 is the starting label
and dlabel the step.
labels – Sets the sector labels. If labels entries are
duplicated, we sum associated values or simply count
occurrences if values is not provided. For other
array attributes (including color) we use the first
non-empty entry among all occurrences of the label.
labelssrc – Sets the source reference on Chart Studio Cloud for
labels.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.pie.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.pie.Marker instance or
dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the
sector.
pull – Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
pullsrc – Sets the source reference on Chart Studio Cloud for
pull.
rotation – Instead of the first slice starting at 12 o’clock, rotate to some other angle.
scalegroup – If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
sort – Determines whether or not the sectors are reordered from largest to smallest.
stream – plotly.graph_objects.pie.Stream instance or
dict with compatible properties
text – Sets text elements associated with each sector. If
trace textinfo contains a “text” flag, these elements
will be seen on the chart. If trace hoverinfo
contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Specifies the location of the textinfo.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables label, color, value, percent and
text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
title – plotly.graph_objects.pie.Title instance or
dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
values – Sets the values of the sectors. If omitted, we count occurrences of each label.
valuessrc – Sets the source reference on Chart Studio Cloud for
values.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_sankey(arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Sankey trace
Sankey plots for network flow data analysis. The nodes are
specified in nodes and the links between sources and targets
in links. The colors are set in nodes[i].color and
links[i].color, otherwise defaults are used.
arrangement – If value is snap (the default), the node arrangement
is assisted by automatic snapping of elements to
preserve space between nodes specified via nodepad.
If value is perpendicular, the nodes can only move
along a line perpendicular to the flow. If value is
freeform, the nodes can freely move on the plane. If
value is fixed, the nodes are stationary.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
domain – plotly.graph_objects.sankey.Domain instance or
dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired. Note that this attribute is
superseded by node.hoverinfo and node.hoverinfo for
nodes and links respectively.
hoverlabel – plotly.graph_objects.sankey.Hoverlabel
instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.sankey.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
link – The links of the Sankey plot.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
node – The nodes of the Sankey plot.
orientation – Sets the orientation of the Sankey diagram.
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
stream – plotly.graph_objects.sankey.Stream instance or
dict with compatible properties
textfont – Sets the font for node labels
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
valueformat – Sets the value 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.
valuesuffix – Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scatter(alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scatter trace
The scatter trace type encompasses line charts, scatter charts,
text charts, and bubble charts. The data visualized as scatter
point or lines is set in x and y. Text (appearing either on
the chart or on hover only) is via text. Bubble charts are
achieved by setting marker.size and/or marker.color to
numerical arrays.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
cliponaxis – Determines whether or not markers and text nodes are
clipped about the subplot axes. To show markers and
text nodes above axis lines and tick labels, make sure
to set xaxis.layer and yaxis.layer to below
traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.scatter.ErrorX instance
or dict with compatible properties
error_y – plotly.graph_objects.scatter.ErrorY instance
or dict with compatible properties
fill – Sets the area to fill with a solid color. Defaults to
“none” unless this trace is stacked, then it gets
“tonexty” (“tonextx”) if orientation is “v” (“h”) Use
with fillcolor if not “none”. “tozerox” and “tozeroy”
fill to x=0 and y=0 respectively. “tonextx” and
“tonexty” fill between the endpoints of this trace and
the endpoints of the trace before it, connecting those
endpoints with straight lines (to make a stacked area
graph); if there is no trace before it, they behave
like “tozerox” and “tozeroy”. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape. “tonext” fills the
space between two traces if one completely encloses the
other (eg consecutive contour lines), and behaves like
“toself” if there is no trace before it. “tonext”
should not be used if one trace does not enclose the
other. Traces in a stackgroup will only fill to (or
be filled to) other traces in the same group. With
multiple `stackgroup`s or some traces stacked and some
not, if fill-linked traces are not already consecutive,
the later ones will be pushed down in the drawing
order.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.
fillgradient – Sets a fill gradient. If not specified, the fillcolor is used instead.
fillpattern – Sets the pattern within the marker.
groupnorm – Only relevant when stackgroup is used, and only the
first groupnorm found in the stackgroup will be
used - including if visible is “legendonly” but not
if it is false. Sets the normalization for the sum of
this stackgroup. With “fraction”, the value of each
trace at each location is divided by the sum of all
trace values at that location. “percent” is the same
but multiplied by 100 to show percentages. If there are
multiple subplots, or multiple `stackgroup`s on one
subplot, each will be normalized within its own set.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scatter.Hoverlabel
instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scatter.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scatter.Line instance or
dict with compatible properties
marker – plotly.graph_objects.scatter.Marker instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Only relevant in the following cases: 1. when
scattermode is set to “group”. 2. when stackgroup
is used, and only the first orientation found in the
stackgroup will be used - including if visible is
“legendonly” but not if it is false. Sets the
stacking direction. With “v” (“h”), the y (x) values of
subsequent traces are added. Also affects the default
value of fill.
selected – plotly.graph_objects.scatter.Selected instance
or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stackgaps – Only relevant when stackgroup is used, and only the
first stackgaps found in the stackgroup will be
used - including if visible is “legendonly” but not
if it is false. Determines how we handle locations at
which other traces in this group have data but this one
does not. With infer zero we insert a zero at these
locations. With “interpolate” we linearly interpolate
between existing values, and extrapolate a constant
beyond the existing values.
stackgroup – Set several scatter traces (on the same subplot) to the
same stackgroup in order to add their y values (or
their x values if orientation is “h”). If blank or
omitted this trace will not be stacked. Stacking also
turns fill on by default, using “tonexty” (“tonextx”)
if orientation is “h” (“v”) and sets the default
mode to “lines” irrespective of point count. You can
only stack on a numeric (linear or log) axis. Traces in
a stackgroup will only fill to (or be filled to)
other traces in the same group. With multiple
`stackgroup`s or some traces stacked and some not, if
fill-linked traces are not already consecutive, the
later ones will be pushed down in the drawing order.
stream – plotly.graph_objects.scatter.Stream instance
or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scatter.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_scatter3d(connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scatter3d trace
The data visualized as scatter point or lines in 3D dimension
is set in x, y, z. Text (appearing either on the chart or
on hover only) is via text. Bubble charts are achieved by
setting marker.size and/or marker.color Projections are
achieved via projection. Surface fills are achieved via
surfaceaxis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
error_x – plotly.graph_objects.scatter3d.ErrorX instance
or dict with compatible properties
error_y – plotly.graph_objects.scatter3d.ErrorY instance
or dict with compatible properties
error_z – plotly.graph_objects.scatter3d.ErrorZ instance
or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scatter3d.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets text elements associated with each (x,y,z)
triplet. If a single string, the same string appears
over all the data points. If an array of string, the
items are mapped in order to the this trace’s (x,y,z)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – :class:`plotly.graph_objects.scatter3d.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scatter3d.Line instance
or dict with compatible properties
marker – plotly.graph_objects.scatter3d.Marker instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
projection – plotly.graph_objects.scatter3d.Projection
instance or dict with compatible properties
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scatter3d.Stream instance
or dict with compatible properties
surfaceaxis – If “-1”, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.
surfacecolor – Sets the surface fill color.
text – Sets text elements associated with each (x,y,z)
triplet. If a single string, the same string appears
over all the data points. If an array of string, the
items are mapped in order to the this trace’s (x,y,z)
coordinates. If trace hoverinfo contains a “text”
flag and “hovertext” is not set, these elements will be
seen in the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with z date data.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scattercarpet(a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scattercarpet trace
Plots a scatter trace on either the first carpet axis or the
carpet axis with a matching carpet attribute.
a – Sets the a-axis coordinates.
asrc – Sets the source reference on Chart Studio Cloud for
a.
b – Sets the b-axis coordinates.
bsrc – Sets the source reference on Chart Studio Cloud for
b.
carpet – An identifier for this carpet, so that scattercarpet
and contourcarpet traces can specify a carpet plot on
which they lie
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. scatterternary has a subset
of the options available to scatter. “toself” connects
the endpoints of the trace (or each segment of the
trace if it has gaps) into a closed shape. “tonext”
fills the space between two traces if one completely
encloses the other (eg consecutive contour lines), and
behaves like “toself” if there is no trace before it.
“tonext” should not be used if one trace does not
enclose the other.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scattercarpet.Hoverlabel
instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (a,b)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b). To
be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scattercarpet.Legendgroupt
itle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scattercarpet.Line
instance or dict with compatible properties
marker – plotly.graph_objects.scattercarpet.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattercarpet.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scattercarpet.Stream
instance or dict with compatible properties
text – Sets text elements associated with each (a,b) point. If
a single string, the same string appears over all the
data points. If an array of strings, the items are
mapped in order to the the data points in (a,b). If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables a, b and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scattercarpet.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_scattergeo(connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scattergeo trace
The data visualized as scatter point or lines on a geographic
map is provided either by longitude/latitude pairs in lon and
lat respectively or by geographic location IDs or names in
locations.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
featureidkey – Sets the key in GeoJSON features which is used as id to
match the items included in the locations array. Only
has an effect when geojson is set. Support nested
property, for example “properties.name”.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
geo – Sets a reference between this trace’s geospatial
coordinates and a geographic map. If “geo” (the default
value), the geospatial coordinates refer to
layout.geo. If “geo2”, the geospatial coordinates
refer to layout.geo2, and so on.
geojson – Sets optional GeoJSON data associated with this trace.
If not given, the features on the base map are used
when locations is set. It can be set as a valid
GeoJSON object or as a URL string. Note that we only
accept GeoJSONs of type “FeatureCollection” or
“Feature” with geometries of type “Polygon” or
“MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scattergeo.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (lon,lat)
pair or item in locations. If a single string, the
same string appears over all the data points. If an
array of string, the items are mapped in order to the
this trace’s (lon,lat) or locations coordinates. To
be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for
lat.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scattergeo.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scattergeo.Line instance
or dict with compatible properties
locationmode – Determines the set of locations used to match entries
in locations to regions on the map. Values “ISO-3”,
“USA-states”, country names correspond to features on
the base map and value “geojson-id” corresponds to
features from a custom GeoJSON linked to the geojson
attribute.
locations – Sets the coordinates via location IDs or names.
Coordinates correspond to the centroid of each location
given. See locationmode for more info.
locationssrc – Sets the source reference on Chart Studio Cloud for
locations.
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for
lon.
marker – plotly.graph_objects.scattergeo.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattergeo.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scattergeo.Stream
instance or dict with compatible properties
text – Sets text elements associated with each (lon,lat) pair
or item in locations. If a single string, the same
string appears over all the data points. If an array of
string, the items are mapped in order to the this
trace’s (lon,lat) or locations coordinates. If trace
hoverinfo contains a “text” flag and “hovertext” is
not set, these elements will be seen in the hover
labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables lat, lon, location and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scattergeo.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scattergl(connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scattergl trace
The data visualized as scatter point or lines is set in x and
y using the WebGL plotting engine. Bubble charts are achieved
by setting marker.size and/or marker.color to a numerical
arrays.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.scattergl.ErrorX instance
or dict with compatible properties
error_y – plotly.graph_objects.scattergl.ErrorY instance
or dict with compatible properties
fill – Sets the area to fill with a solid color. Defaults to
“none” unless this trace is stacked, then it gets
“tonexty” (“tonextx”) if orientation is “v” (“h”) Use
with fillcolor if not “none”. “tozerox” and “tozeroy”
fill to x=0 and y=0 respectively. “tonextx” and
“tonexty” fill between the endpoints of this trace and
the endpoints of the trace before it, connecting those
endpoints with straight lines (to make a stacked area
graph); if there is no trace before it, they behave
like “tozerox” and “tozeroy”. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape. “tonext” fills the
space between two traces if one completely encloses the
other (eg consecutive contour lines), and behaves like
“toself” if there is no trace before it. “tonext”
should not be used if one trace does not enclose the
other. Traces in a stackgroup will only fill to (or
be filled to) other traces in the same group. With
multiple `stackgroup`s or some traces stacked and some
not, if fill-linked traces are not already consecutive,
the later ones will be pushed down in the drawing
order.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scattergl.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – :class:`plotly.graph_objects.scattergl.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scattergl.Line instance
or dict with compatible properties
marker – plotly.graph_objects.scattergl.Marker instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattergl.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scattergl.Stream instance
or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scattergl.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_scattermap(below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scattermap trace
The data visualized as scatter point, lines or marker symbols
on a MapLibre GL geographic map is provided by
longitude/latitude pairs in lon and lat.
below – Determines if this scattermap trace’s layers are to be
inserted before the layer with the specified ID. By
default, scattermap layers are inserted above all the
base layers. To place the scattermap layers above every
other layer, set below to “’’”.
cluster – plotly.graph_objects.scattermap.Cluster
instance or dict with compatible properties
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scattermap.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (lon,lat)
pair If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (lon,lat)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for
lat.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scattermap.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scattermap.Line instance
or dict with compatible properties
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for
lon.
marker – plotly.graph_objects.scattermap.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattermap.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scattermap.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a map subplot. If “map” (the default value), the
data refer to layout.map. If “map2”, the data refer
to layout.map2, and so on.
text – Sets text elements associated with each (lon,lat) pair
If a single string, the same string appears over all
the data points. If an array of string, the items are
mapped in order to the this trace’s (lon,lat)
coordinates. If trace hoverinfo contains a “text”
flag and “hovertext” is not set, these elements will be
seen in the hover labels.
textfont – Sets the icon text font (color=map.layer.paint.text-
color, size=map.layer.layout.text-size). Has an effect
only when type is set to “symbol”.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables lat, lon and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scattermap.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scattermapbox(below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scattermapbox trace
“scattermapbox” trace is deprecated! Please consider switching
to the “scattermap” trace type and map subplots. Learn more
at: https://plotly.com/python/maplibre-migration/ as well as
https://plotly.com/javascript/maplibre-migration/ The data
visualized as scatter point, lines or marker symbols on a
Mapbox GL geographic map is provided by longitude/latitude
pairs in lon and lat.
below – Determines if this scattermapbox trace’s layers are to
be inserted before the layer with the specified ID. By
default, scattermapbox layers are inserted above all
the base layers. To place the scattermapbox layers
above every other layer, set below to “’’”.
cluster – plotly.graph_objects.scattermapbox.Cluster
instance or dict with compatible properties
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scattermapbox.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (lon,lat)
pair If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (lon,lat)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for
lat.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scattermapbox.Legendgroupt
itle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scattermapbox.Line
instance or dict with compatible properties
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for
lon.
marker – plotly.graph_objects.scattermapbox.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattermapbox.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scattermapbox.Stream
instance or dict with compatible properties
subplot – mapbox subplots and traces are deprecated! Please
consider switching to map subplots and traces. Learn
more at: https://plotly.com/python/maplibre-migration/
as well as https://plotly.com/javascript/maplibre-
migration/ Sets a reference between this trace’s data
coordinates and a mapbox subplot. If “mapbox” (the
default value), the data refer to layout.mapbox. If
“mapbox2”, the data refer to layout.mapbox2, and so
on.
text – Sets text elements associated with each (lon,lat) pair
If a single string, the same string appears over all
the data points. If an array of string, the items are
mapped in order to the this trace’s (lon,lat)
coordinates. If trace hoverinfo contains a “text”
flag and “hovertext” is not set, these elements will be
seen in the hover labels.
textfont – Sets the icon text font (color=mapbox.layer.paint.text-
color, size=mapbox.layer.layout.text-size). Has an
effect only when type is set to “symbol”.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables lat, lon and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scattermapbox.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scatterpolar(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scatterpolar trace
The scatterpolar trace type encompasses line charts, scatter
charts, text charts, and bubble charts in polar coordinates.
The data visualized as scatter point or lines is set in r
(radial) and theta (angular) coordinates Text (appearing
either on the chart or on hover only) is via text. Bubble
charts are achieved by setting marker.size and/or
marker.color to numerical arrays.
cliponaxis – Determines whether or not markers and text nodes are
clipped about the subplot axes. To show markers and
text nodes above axis lines and tick labels, make sure
to set xaxis.layer and yaxis.layer to below
traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the
dtheta step equals the subplot’s period divided by
the length of the r coordinates.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. scatterpolar has a subset of
the options available to scatter. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape. “tonext” fills the
space between two traces if one completely encloses the
other (eg consecutive contour lines), and behaves like
“toself” if there is no trace before it. “tonext”
should not be used if one trace does not enclose the
other.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scatterpolar.Hoverlabel
instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scatterpolar.Legendgroupti
tle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scatterpolar.Line
instance or dict with compatible properties
marker – plotly.graph_objects.scatterpolar.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r
coordinates. Use with dr where r0 is the starting
coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for
r.
selected – plotly.graph_objects.scatterpolar.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scatterpolar.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a polar subplot. If “polar” (the default value),
the data refer to layout.polar. If “polar2”, the data
refer to layout.polar2, and so on.
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables r, theta and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta
coordinates. Use with dtheta where theta0 is the
starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for
theta.
thetaunit – Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterpolar.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scatterpolargl(connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scatterpolargl trace
The scatterpolargl trace type encompasses line charts, scatter
charts, and bubble charts in polar coordinates using the WebGL
plotting engine. The data visualized as scatter point or lines
is set in r (radial) and theta (angular) coordinates Bubble
charts are achieved by setting marker.size and/or
marker.color to numerical arrays.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the
dtheta step equals the subplot’s period divided by
the length of the r coordinates.
fill – Sets the area to fill with a solid color. Defaults to
“none” unless this trace is stacked, then it gets
“tonexty” (“tonextx”) if orientation is “v” (“h”) Use
with fillcolor if not “none”. “tozerox” and “tozeroy”
fill to x=0 and y=0 respectively. “tonextx” and
“tonexty” fill between the endpoints of this trace and
the endpoints of the trace before it, connecting those
endpoints with straight lines (to make a stacked area
graph); if there is no trace before it, they behave
like “tozerox” and “tozeroy”. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape. “tonext” fills the
space between two traces if one completely encloses the
other (eg consecutive contour lines), and behaves like
“toself” if there is no trace before it. “tonext”
should not be used if one trace does not enclose the
other. Traces in a stackgroup will only fill to (or
be filled to) other traces in the same group. With
multiple `stackgroup`s or some traces stacked and some
not, if fill-linked traces are not already consecutive,
the later ones will be pushed down in the drawing
order.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scatterpolargl.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scatterpolargl.Legendgroup
title instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scatterpolargl.Line
instance or dict with compatible properties
marker – plotly.graph_objects.scatterpolargl.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r
coordinates. Use with dr where r0 is the starting
coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for
r.
selected – plotly.graph_objects.scatterpolargl.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scatterpolargl.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a polar subplot. If “polar” (the default value),
the data refer to layout.polar. If “polar2”, the data
refer to layout.polar2, and so on.
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables r, theta and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta
coordinates. Use with dtheta where theta0 is the
starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for
theta.
thetaunit – Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterpolargl.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scattersmith(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scattersmith trace
The scattersmith trace type encompasses line charts, scatter
charts, text charts, and bubble charts in smith coordinates.
The data visualized as scatter point or lines is set in real
and imag (imaginary) coordinates Text (appearing either on
the chart or on hover only) is via text. Bubble charts are
achieved by setting marker.size and/or marker.color to
numerical arrays.
cliponaxis – Determines whether or not markers and text nodes are
clipped about the subplot axes. To show markers and
text nodes above axis lines and tick labels, make sure
to set xaxis.layer and yaxis.layer to below
traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. scattersmith has a subset of
the options available to scatter. “toself” connects the
endpoints of the trace (or each segment of the trace if
it has gaps) into a closed shape. “tonext” fills the
space between two traces if one completely encloses the
other (eg consecutive contour lines), and behaves like
“toself” if there is no trace before it. “tonext”
should not be used if one trace does not enclose the
other.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scattersmith.Hoverlabel
instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
imag – Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.
imagsrc – Sets the source reference on Chart Studio Cloud for
imag.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scattersmith.Legendgroupti
tle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scattersmith.Line
instance or dict with compatible properties
marker – plotly.graph_objects.scattersmith.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
real – Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.
realsrc – Sets the source reference on Chart Studio Cloud for
real.
selected – plotly.graph_objects.scattersmith.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scattersmith.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a smith subplot. If “smith” (the default value),
the data refer to layout.smith. If “smith2”, the data
refer to layout.smith2, and so on.
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables real, imag and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scattersmith.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_scatterternary(a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Scatterternary trace
Provides similar functionality to the “scatter” type but on a
ternary phase diagram. The data is provided by at least two
arrays out of a, b, c triplets.
a – Sets the quantity of component a in each data point.
If a, b, and c are all provided, they need not be
normalized, only the relative values matter. If only
two arrays are provided they must be normalized to
match ternary<i>.sum.
asrc – Sets the source reference on Chart Studio Cloud for
a.
b – Sets the quantity of component a in each data point.
If a, b, and c are all provided, they need not be
normalized, only the relative values matter. If only
two arrays are provided they must be normalized to
match ternary<i>.sum.
bsrc – Sets the source reference on Chart Studio Cloud for
b.
c – Sets the quantity of component a in each data point.
If a, b, and c are all provided, they need not be
normalized, only the relative values matter. If only
two arrays are provided they must be normalized to
match ternary<i>.sum.
cliponaxis – Determines whether or not markers and text nodes are
clipped about the subplot axes. To show markers and
text nodes above axis lines and tick labels, make sure
to set xaxis.layer and yaxis.layer to below
traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
csrc – Sets the source reference on Chart Studio Cloud for
c.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
fill – Sets the area to fill with a solid color. Use with
fillcolor if not “none”. scatterternary has a subset
of the options available to scatter. “toself” connects
the endpoints of the trace (or each segment of the
trace if it has gaps) into a closed shape. “tonext”
fills the space between two traces if one completely
encloses the other (eg consecutive contour lines), and
behaves like “toself” if there is no trace before it.
“tonext” should not be used if one trace does not
enclose the other.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.scatterternary.Hoverlabel
instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (a,b,c)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b,c).
To be seen, trace hoverinfo must contain a “text”
flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.scatterternary.Legendgroup
title instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.scatterternary.Line
instance or dict with compatible properties
marker – plotly.graph_objects.scatterternary.Marker
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
mode – Determines the drawing mode for this scatter trace. If
the provided mode includes “text” then the text
elements appear at the coordinates. Otherwise, the
text elements appear on hover. If there are less than
20 points and the trace is not stacked then the default
is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scatterternary.Selected
instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.scatterternary.Stream
instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates
and a ternary subplot. If “ternary” (the default
value), the data refer to layout.ternary. If
“ternary2”, the data refer to layout.ternary2, and so
on.
sum – The number each triplet should sum to, if only two of
a, b, and c are provided. This overrides
ternary<i>.sum to normalize this specific trace, but
does not affect the values displayed on the axes. 0 (or
missing) means to use ternary<i>.sum
text – Sets text elements associated with each (a,b,c) point.
If a single string, the same string appears over all
the data points. If an array of strings, the items are
mapped in order to the the data points in (a,b,c). If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects
to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables a, b, c and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterternary.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_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, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure¶Create and add a new selection to the figure’s layout
arg – instance of Selection or dict with compatible properties
line – plotly.graph_objects.layout.selection.Line
instance or dict with compatible properties
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.
opacity – Sets the opacity of the selection.
path – For type “path” - a valid SVG path similar to
shapes.path in data coordinates. Allowed segments
are: M, L and Z.
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.
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.
x0 – Sets the selection’s starting x position.
x1 – Sets the selection’s end x position.
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.
y0 – Sets the selection’s starting y position.
y1 – Sets the selection’s end y position.
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.
row – Subplot row for selection. If ‘all’, addresses all rows in the specified column(s).
col – Subplot column for selection. If ‘all’, addresses all columns in the specified row(s).
secondary_y – Whether to add selection to secondary y-axis
exclude_empty_subplots – If True, selection will not be added to subplots without traces.
add_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, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure¶Create and add a new shape to the figure’s layout
arg – instance of Shape or dict with compatible properties
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.
fillcolor – Sets the color filling the shape’s interior. Only applies to closed shapes.
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
label – plotly.graph_objects.layout.shape.Label
instance or dict with compatible properties
layer – Specifies whether shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).
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.
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.
legendgrouptitle – plotly.graph_objects.layout.shape.Legendgroupti
tle instance or dict with compatible properties
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.
legendwidth – Sets the width (in px or fraction) of the legend for this shape.
line – plotly.graph_objects.layout.shape.Line
instance or dict with compatible properties
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.
opacity – Sets the opacity of the shape.
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
showlegend – Determines whether or not this shape is shown in the legend.
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.
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.
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).
x0 – Sets the shape’s starting x position. See type and
xsizemode for more info.
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.
x1 – Sets the shape’s end x position. See type and
xsizemode for more info.
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.
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”.
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.
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.
y0 – Sets the shape’s starting y position. See type and
ysizemode for more info.
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.
y1 – Sets the shape’s end y position. See type and
ysizemode for more info.
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.
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”.
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.
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.
row – Subplot row for shape. If ‘all’, addresses all rows in the specified column(s).
col – Subplot column for shape. If ‘all’, addresses all columns in the specified row(s).
secondary_y – Whether to add shape to secondary y-axis
exclude_empty_subplots – If True, shape will not be added to subplots without traces.
add_splom(customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Splom trace
Splom traces generate scatter plot matrix visualizations. Each
splom dimensions items correspond to a generated axis. Values
for each of those dimensions are set in dimensions[i].values.
Splom traces support all scattergl marker style attributes.
Specify layout.grid attributes and/or layout x-axis and
y-axis attributes for more control over the axis positioning
and style.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
diagonal – plotly.graph_objects.splom.Diagonal instance
or dict with compatible properties
dimensions – A tuple of
plotly.graph_objects.splom.Dimension instances
or dicts with compatible properties
dimensiondefaults – When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.splom.Hoverlabel instance
or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.splom.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
marker – plotly.graph_objects.splom.Marker instance or
dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.splom.Selected instance
or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showlowerhalf – Determines whether or not subplots on the lower half from the diagonal are displayed.
showupperhalf – Determines whether or not subplots on the upper half from the diagonal are displayed.
stream – plotly.graph_objects.splom.Stream instance or
dict with compatible properties
text – Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.splom.Unselected instance
or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
xaxes – Sets the list of x axes corresponding to dimensions of
this splom trace. By default, a splom will match the
first N xaxes where N is the number of input
dimensions. Note that, in case where diagonal.visible
is false and showupperhalf or showlowerhalf is
false, this splom trace will generate one less x-axis
and one less y-axis.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
yaxes – Sets the list of y axes corresponding to dimensions of
this splom trace. By default, a splom will match the
first N yaxes where N is the number of input
dimensions. Note that, in case where diagonal.visible
is false and showupperhalf or showlowerhalf is
false, this splom trace will generate one less x-axis
and one less y-axis.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_streamtube(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Streamtube trace
Use a streamtube trace to visualize flow in a vector field.
Specify a vector field using 6 1D arrays of equal length, 3
position arrays x, y and z and 3 vector component arrays
u, v, and w. By default, the tubes’ starting positions
will be cut from the vector field’s x-z plane at its minimum y
value. To specify your own starting position, use attributes
starts.x, starts.y and starts.z. The color is encoded by
the norm of (u, v, w), and the local radius by the divergence
of (u, v, w).
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.
cauto – Determines whether or not the color domain is computed
with respect to the input data (here u/v/w norm) or the
bounds set in cmin and cmax Defaults to false
when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as u/v/w norm and if set, cmin
must be set as well.
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 u/v/w norm. Has no
effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should
have the same units as u/v/w norm and if set, cmax
must be set as well.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.streamtube.ColorBar
instance or dict with compatible properties
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,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.streamtube.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables tubex, tubey, tubez, tubeu,
tubev, tubew, norm and divergence. Anything
contained in tag <extra> is displayed in the
secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.streamtube.Legendgrouptitl
e instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lighting – plotly.graph_objects.streamtube.Lighting
instance or dict with compatible properties
lightposition – plotly.graph_objects.streamtube.Lightposition
instance or dict with compatible properties
maxdisplayed – The maximum number of displayed segments in a streamtube.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
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.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
sizeref – The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.
starts – plotly.graph_objects.streamtube.Starts
instance or dict with compatible properties
stream – plotly.graph_objects.streamtube.Stream
instance or dict with compatible properties
text – Sets a text element associated with this trace. If
trace hoverinfo contains a “text” flag, this text
element will be seen in all hover labels. Note that
streamtube traces do not support array text values.
u – Sets the x components of the vector field.
uhoverformat – Sets the hover text formatting rulefor u using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
usrc – Sets the source reference on Chart Studio Cloud for
u.
v – Sets the y components of the vector field.
vhoverformat – Sets the hover text formatting rulefor v using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
vsrc – Sets the source reference on Chart Studio Cloud for
v.
w – Sets the z components of the vector field.
whoverformat – Sets the hover text formatting rulefor w using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
wsrc – Sets the source reference on Chart Studio Cloud for
w.
x – Sets the x coordinates of the vector field.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates of the vector field.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the z coordinates of the vector field.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_sunburst(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Sunburst trace
Visualize hierarchal data spanning outward radially from root to leaves. The sunburst sectors are determined by the entries in “labels” or “ids” and in “parents”.
branchvalues – Determines how the items in values are summed. When
set to “total”, items in values are taken to be value
of all its descendants. When set to “remainder”, items
in values corresponding to the root and the branches
sectors are taken to be the extra part not part of the
sum of the values at their leaves.
count – Determines default for values when it is not
provided, by inferring a 1 for each of the “leaves”
and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
domain – plotly.graph_objects.sunburst.Domain instance
or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.sunburst.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables currentPath, root, entry,
percentRoot, percentEntry and percentParent.
Anything contained in tag <extra> is displayed in the
secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each sector.
If a single string, the same string appears for all
data points. If an array of string, the items are
mapped in order of this trace’s sectors. To be seen,
trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextfont – Sets the font used for textinfo lying inside the
sector.
insidetextorientation – Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for
labels.
leaf – plotly.graph_objects.sunburst.Leaf instance or
dict with compatible properties
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.sunburst.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
level – Sets the level from which this trace hierarchy is
rendered. Set level to '' to start from the root
node in the hierarchy. Must be an “id” if ids is
filled in, otherwise plotly attempts to find a matching
item in labels.
marker – plotly.graph_objects.sunburst.Marker instance
or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given
level. Set maxdepth to “-1” to render all the
levels in the hierarchy.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the
sector. This option refers to the root of the hierarchy
presented at the center of a sunburst graph. Please
note that if a hierarchy has multiple root nodes, this
option won’t have any effect and insidetextfont would
be used.
parents – Sets the parent sectors for each of the sectors. Empty
string items ‘’ are understood to reference the root
node in the hierarchy. If ids is filled, parents
items are understood to be “ids” themselves. When ids
is not set, plotly attempts to find matching items in
labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for
parents.
root – plotly.graph_objects.sunburst.Root instance or
dict with compatible properties
rotation – Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o’clock.
sort – Determines whether or not the sectors are reordered from largest to smallest.
stream – plotly.graph_objects.sunburst.Stream instance
or dict with compatible properties
text – Sets text elements associated with each sector. If
trace textinfo contains a “text” flag, these elements
will be seen on the chart. If trace hoverinfo
contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables currentPath, root, entry,
percentRoot, percentEntry, percentParent, label
and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
values – Sets the values associated with each of the sectors.
Use with branchvalues to determine how the values are
summed.
valuessrc – Sets the source reference on Chart Studio Cloud for
values.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_surface(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Surface trace
The data the describes the coordinates of the surface is set in
z. Data in z should be a 2D list. Coordinates in x and
y can either be 1D lists or 2D lists (e.g. to graph
parametric surfaces). If not provided in x and y, the x and
y coordinates are assumed to be linear starting at 0 with a
unit step. The color scale corresponds to the z values by
default. For custom color scales, use surfacecolor which
should be a 2D list, where its bounds can be controlled using
cmin and cmax.
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.
cauto – Determines whether or not the color domain is computed
with respect to the input data (here z or surfacecolor)
or the bounds set in cmin and cmax Defaults to
false when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as z or surfacecolor and if set,
cmin must be set as well.
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 z or surfacecolor.
Has no effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should
have the same units as z or surfacecolor and if set,
cmax must be set as well.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.surface.ColorBar instance
or dict with compatible properties
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,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing
values) in the z data are filled in.
contours – plotly.graph_objects.surface.Contours instance
or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
hidesurface – Determines whether or not a surface is drawn. For
example, set hidesurface to False contours.x.show
to True and contours.y.show to True to draw a wire
frame plot.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.surface.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.surface.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lighting – plotly.graph_objects.surface.Lighting instance
or dict with compatible properties
lightposition – plotly.graph_objects.surface.Lightposition
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an
array containing arrays mapping a normalized value to
an opacity value. At minimum, a mapping for the lowest
(0) and highest (1) values are required. For example,
[[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower
values would have higher opacity values and those in
the middle would be more transparent Alternatively,
opacityscale may be a palette name string of the
following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’.
The default is ‘uniform’.
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.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream – plotly.graph_objects.surface.Stream instance
or dict with compatible properties
surfacecolor – Sets the surface color values, used for setting a color
scale independent of z.
surfacecolorsrc – Sets the source reference on Chart Studio Cloud for
surfacecolor.
text – Sets the text elements associated with each z value. If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the x coordinates.
xcalendar – Sets the calendar system to use with x date data.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with y date data.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with z date data.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_table(cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Table trace
Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column- major order, ie. the grid is represented as a vector of column vectors.
cells – plotly.graph_objects.table.Cells instance or
dict with compatible properties
columnorder – Specifies the rendered order of the data columns; for
example, a value 2 at position 0 means that column
index 0 in the data will be rendered as the third
column, as columns have an index base of zero.
columnordersrc – Sets the source reference on Chart Studio Cloud for
columnorder.
columnwidth – The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
columnwidthsrc – Sets the source reference on Chart Studio Cloud for
columnwidth.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
domain – plotly.graph_objects.table.Domain instance or
dict with compatible properties
header – plotly.graph_objects.table.Header instance or
dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.table.Hoverlabel instance
or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.table.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
stream – plotly.graph_objects.table.Stream instance or
dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_trace(trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) → plotly.graph_objects._figure.Figure¶Add a trace to the figure
trace (BaseTraceType or dict) –
An instances of a trace classe from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar)
or a dicts where:
The ‘type’ property specifies the trace type (e.g. ‘scatter’, ‘bar’, ‘area’, etc.). If the dict has no ‘type’ property then ‘scatter’ is assumed.
All remaining properties are passed to the constructor of the specified trace type.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.
If ‘all’, addresses all rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.
If ‘all’, addresses all columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
The trace argument is a 2D cartesian trace (scatter, bar, etc.)
exclude_empty_subplots (boolean) – If True, the trace will not be added to subplots that don’t already have traces.
The Figure that add_trace was called on
Examples
>>> from plotly import subplots
>>> import plotly.graph_objects as go
Add two Scatter traces to a figure
>>> fig = go.Figure()
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]))
Figure(...)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]))
Figure(...)
Add two Scatter traces to vertically stacked subplots
>>> fig = subplots.make_subplots(rows=2)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1)
Figure(...)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1)
Figure(...)
add_traces(data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) → plotly.graph_objects._figure.Figure¶Add traces to the figure
data (list[BaseTraceType or dict]) –
A list of trace specifications to be added. Trace specifications may be either:
Instances of trace classes from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar)
Dicts where:
The ‘type’ property specifies the trace type (e.g. ‘scatter’, ‘bar’, ‘area’, etc.). If the dict has no ‘type’ property then ‘scatter’ is assumed.
All remaining properties are passed to the constructor of the specified trace type.
rows (None, list[int], or int (default None)) – List of subplot row indexes (starting from 1) for the traces to be
added. Only valid if figure was created using
plotly.tools.make_subplots
If a single integer is passed, all traces will be added to row number
cols (None or list[int] (default None)) – List of subplot column indexes (starting from 1) for the traces
to be added. Only valid if figure was created using
plotly.tools.make_subplots
If a single integer is passed, all traces will be added to column number
List of secondary_y booleans for traces to be added. See the
docstring for add_trace for more info.
If True, the trace will not be added to subplots that don’t already have traces.
The Figure that add_traces was called on
Examples
>>> from plotly import subplots
>>> import plotly.graph_objects as go
Add two Scatter traces to a figure
>>> fig = go.Figure()
>>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
... go.Scatter(x=[1,2,3], y=[2,1,2])])
Figure(...)
Add two Scatter traces to vertically stacked subplots
>>> fig = subplots.make_subplots(rows=2)
>>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
... go.Scatter(x=[1,2,3], y=[2,1,2])],
... rows=[1, 2], cols=[1, 1])
Figure(...)
add_treemap(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Treemap trace
Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The treemap sectors are determined by the entries in “labels” or “ids” and in “parents”.
branchvalues – Determines how the items in values are summed. When
set to “total”, items in values are taken to be value
of all its descendants. When set to “remainder”, items
in values corresponding to the root and the branches
sectors are taken to be the extra part not part of the
sum of the values at their leaves.
count – Determines default for values when it is not
provided, by inferring a 1 for each of the “leaves”
and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
domain – plotly.graph_objects.treemap.Domain instance
or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.treemap.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables currentPath, root, entry,
percentRoot, percentEntry and percentParent.
Anything contained in tag <extra> is displayed in the
secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each sector.
If a single string, the same string appears for all
data points. If an array of string, the items are
mapped in order of this trace’s sectors. To be seen,
trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
insidetextfont – Sets the font used for textinfo lying inside the
sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for
labels.
legend – Sets the reference to a legend to show this trace 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.
legendgrouptitle – plotly.graph_objects.treemap.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
level – Sets the level from which this trace hierarchy is
rendered. Set level to '' to start from the root
node in the hierarchy. Must be an “id” if ids is
filled in, otherwise plotly attempts to find a matching
item in labels.
marker – plotly.graph_objects.treemap.Marker instance
or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given
level. Set maxdepth to “-1” to render all the
levels in the hierarchy.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the
sector. This option refers to the root of the hierarchy
presented on top left corner of a treemap graph. Please
note that if a hierarchy has multiple root nodes, this
option won’t have any effect and insidetextfont would
be used.
parents – Sets the parent sectors for each of the sectors. Empty
string items ‘’ are understood to reference the root
node in the hierarchy. If ids is filled, parents
items are understood to be “ids” themselves. When ids
is not set, plotly attempts to find matching items in
labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for
parents.
pathbar – plotly.graph_objects.treemap.Pathbar instance
or dict with compatible properties
root – plotly.graph_objects.treemap.Root instance or
dict with compatible properties
sort – Determines whether or not the sectors are reordered from largest to smallest.
stream – plotly.graph_objects.treemap.Stream instance
or dict with compatible properties
text – Sets text elements associated with each sector. If
trace textinfo contains a “text” flag, these elements
will be seen on the chart. If trace hoverinfo
contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Sets the positions of the text elements.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables currentPath, root, entry,
percentRoot, percentEntry, percentParent, label
and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
tiling – plotly.graph_objects.treemap.Tiling instance
or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
values – Sets the values associated with each of the sectors.
Use with branchvalues to determine how the values are
summed.
valuessrc – Sets the source reference on Chart Studio Cloud for
values.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_violin(alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Violin trace
In vertical (horizontal) violin plots, statistics are computed
using y (x) values. By supplying an x (y) array, one
violin per distinct x (y) value is drawn If no x (y) list
is provided, a single violin is drawn. That violin position is
then positioned with with name or with x0 (y0) if
provided.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
bandwidth – Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman’s rule of thumb.
box – plotly.graph_objects.violin.Box instance or
dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.violin.Hoverlabel
instance or dict with compatible properties
hoveron – Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
jitter – Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.violin.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line – plotly.graph_objects.violin.Line instance or
dict with compatible properties
marker – plotly.graph_objects.violin.Marker instance or
dict with compatible properties
meanline – plotly.graph_objects.violin.Meanline instance
or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the
legend item and on hover. For violin traces, the name
will also be used for the position coordinate, if x
and x0 (y and y0 if horizontal) are missing and
the position axis is categorical. Note that the trace
name is also used as a default value for attribute
scalegroup (please see its description for details).
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the violin(s). If “v” (“h”), the distribution is visualized along the vertical (horizontal).
pointpos – Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.
points – If “outliers”, only the sample points lying outside the
whiskers are shown If “suspectedoutliers”, the outlier
points are shown and points either less than 4*Q1-3*Q3
or greater than 4*Q3-3*Q1 are highlighted (see
outliercolor) If “all”, all sample points are shown
If False, only the violins are shown with no sample
points. Defaults to “suspectedoutliers” when
marker.outliercolor or marker.line.outliercolor is
set, otherwise defaults to “outliers”.
quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
scalegroup – If there are multiple violins that should be sized
according to to some metric (see scalemode), link
them by providing a non-empty group id here shared by
every trace in the same group. If a violin’s width is
undefined, scalegroup will default to the trace’s
name. In this case, violins with the same names will be
linked together
scalemode – Sets the metric by which the width of each violin is determined. “width” means each violin has the same (max) width “count” means the violins are scaled by the number of sample points making up each violin.
selected – plotly.graph_objects.violin.Selected instance
or dict with compatible properties
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
side – Determines on which side of the position value the
density function making up one half of a violin is
plotted. Useful when comparing two violin traces under
“overlay” mode, where one trace has side set to
“positive” and the other to “negative”.
span – Sets the span in data space for which the density
function will be computed. Has an effect only when
spanmode is set to “manual”.
spanmode – Sets the method by which the span in data space where
the density function will be computed. “soft” means the
span goes from the sample’s minimum value minus two
bandwidths to the sample’s maximum value plus two
bandwidths. “hard” means the span goes from the
sample’s minimum to its maximum value. For custom span
settings, use mode “manual” and fill in the span
attribute.
stream – plotly.graph_objects.violin.Stream instance or
dict with compatible properties
text – Sets the text elements associated with each sample
value. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
unselected – plotly.graph_objects.violin.Unselected
instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
width – Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.
x – Sets the x sample data or coordinates. See overview for more info.
x0 – Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y sample data or coordinates. See overview for more info.
y0 – Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
add_vline(x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a vertical line to a plot or subplot that extends infinitely in the y-dimension.
x (float or int) – A number representing the x coordinate of the vertical line.
exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.
row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.
annotation_position (a string containing optionally ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the line. Example positions are “bottom left”, “right top”, “right”, “bottom”. If an annotation is added but annotation_position is not specified, this defaults to “top right”.
annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.
**kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.
add_volume(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Volume trace
Draws volume trace between iso-min and iso-max values with
coordinates given by four 1-dimensional arrays containing the
value, x, y and z of every vertex of a uniform or non-
uniform 3-D grid. Horizontal or vertical slices, caps as well
as spaceframe between iso-min and iso-max values could also be
drawn using this trace.
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.
caps – plotly.graph_objects.volume.Caps instance or
dict with compatible properties
cauto – Determines whether or not the color domain is computed
with respect to the input data (here value) or the
bounds set in cmin and cmax Defaults to false
when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as value and if set, cmin must
be set as well.
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 value. Has no
effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should
have the same units as value and if set, cmax must
be set as well.
coloraxis – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under layout.coloraxis,
layout.coloraxis2, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar – plotly.graph_objects.volume.ColorBar instance
or dict with compatible properties
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,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
contour – plotly.graph_objects.volume.Contour instance
or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.volume.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Anything contained in tag <extra> is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – plotly.graph_objects.volume.Legendgrouptitle
instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
lighting – plotly.graph_objects.volume.Lighting instance
or dict with compatible properties
lightposition – plotly.graph_objects.volume.Lightposition
instance or dict with compatible properties
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an
array containing arrays mapping a normalized value to
an opacity value. At minimum, a mapping for the lowest
(0) and highest (1) values are required. For example,
[[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower
values would have higher opacity values and those in
the middle would be more transparent Alternatively,
opacityscale may be a palette name string of the
following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’.
The default is ‘uniform’.
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.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
slices – plotly.graph_objects.volume.Slices instance or
dict with compatible properties
spaceframe – plotly.graph_objects.volume.Spaceframe
instance or dict with compatible properties
stream – plotly.graph_objects.volume.Stream instance or
dict with compatible properties
surface – plotly.graph_objects.volume.Surface instance
or dict with compatible properties
text – Sets the text elements associated with the vertices. If
trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
value – Sets the 4th dimension (value) of the vertices.
valuehoverformat – Sets the hover text formatting rulefor value using
d3 formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
valuesrc – Sets the source reference on Chart Studio Cloud for
value.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
x – Sets the X coordinates of the vertices on X axis.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the Y coordinates of the vertices on Y axis.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
z – Sets the Z coordinates of the vertices on Z axis.
zhoverformat – Sets the hover text formatting rulefor z 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*By default the values are
formatted using zaxis.hoverformat.
zsrc – Sets the source reference on Chart Studio Cloud for
z.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
add_vrect(x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a rectangle to a plot or subplot that extends infinitely in the y-dimension.
x0 (float or int) – A number representing the x coordinate of one side of the rectangle.
x1 (float or int) – A number representing the x coordinate of the other side of the rectangle.
exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.
row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.
annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.
annotation_position (a string containing optionally ["inside", "outside"], ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the rectangle. Example positions are “outside top left”, “inside bottom”, “right”, “inside left”, “inside” (“outside” is not supported). If an annotation is added but annotation_position is not specified this defaults to “inside top right”.
annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.
**kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.
add_waterfall(alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Add a new Waterfall trace
Draws waterfall trace which is useful graph to displays the
contribution of various elements (either positive or negative)
in a bar chart. The data visualized by the span of the bars is
set in y if orientation is set to “v” (the default) and the
labels are set in x. By setting orientation to “h”, the
roles are interchanged.
alignmentgroup – Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
base – Sets where the bar base is drawn (in position axis units).
cliponaxis – Determines whether the text nodes are clipped about the
subplot axes. To show the text nodes above axis lines
and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
connector – plotly.graph_objects.waterfall.Connector
instance or dict with compatible properties
constraintext – Constrain the size of text inside or outside a bar to be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.
decreasing – plotly.graph_objects.waterfall.Decreasing
instance or dict with compatible properties
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If
none or skip are set, no information is displayed
upon hovering. But, if none is set, click and hover
events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.
hoverlabel – plotly.graph_objects.waterfall.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables initial, delta and final. Anything
contained in tag <extra> is displayed in the
secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.
hovertext – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace hoverinfo must contain
a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.
increasing – plotly.graph_objects.waterfall.Increasing
instance or dict with compatible properties
insidetextanchor – Determines if texts are kept at center or start/end
points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legend – Sets the reference to a legend to show this trace 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.
legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – :class:`plotly.graph_objects.waterfall.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. 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.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
measure – An array containing types of values. By default the values are considered as ‘relative’. However; it is possible to use ‘total’ to compute the sums. Also ‘absolute’ could be applied to reset the computed total or to declare an initial value where needed.
measuresrc – Sets the source reference on Chart Studio Cloud for
measure.
meta – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace name, graph, axis and
colorbar title.text, annotation text
rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta
values in an attribute in the same trace, simply use
%{meta[i]} where i is the index or key of the
meta item in question. To access trace meta in
layout attributes, use %{data[n[.meta[i]} where i
is the index or key of the meta and n is the trace
index.
metasrc – Sets the source reference on Chart Studio Cloud for
meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.
offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
offsetsrc – Sets the source reference on Chart Studio Cloud for
offset.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
selectedpoints – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the unselected are turned on for all points, whereas,
any other non-array values means no selection all where
the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.waterfall.Stream instance
or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textangle – Sets the angle of the tick labels with respect to the
bar. For example, a tickangle of -90 draws the tick
labels vertically. With “auto” the texts may
automatically be rotated to fit with the maximum size
in bars.
textfont – Sets the font used for text.
textinfo – Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).
textposition – Specifies the location of the text. “inside”
positions text inside, next to the bar end (rotated
and scaled if needed). “outside” positions text
outside, next to the bar end (scaled if needed), unless
there is another bar stacked on this one, then the text
gets pushed inside. “auto” tries to position text
inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If
“none”, no text appears.
textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition.
textsrc – Sets the source reference on Chart Studio Cloud for
text.
texttemplate – Template string used for rendering the information text
that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Every attributes that can be
specified per-point (the ones that are arrayOk: true)
are available. Finally, the template string has access
to variables initial, delta, final and label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.
totals – plotly.graph_objects.waterfall.Totals instance
or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the
trace: constraintrange in parcoords traces, as well
as some editable: true modifications such as name
and colorbar.title. Defaults to layout.uirevision.
Note that other user-driven trace attribute changes are
controlled by layout attributes: trace.visible is
controlled by layout.legend.uirevision,
selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y)
(accessible with config: {editable: true}) is
controlled by layout.editrevision. Trace changes are
tracked by uid, which only falls back on trace index
if no uid is provided. So if your app can add/remove
traces before the end of the data array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
width – Sets the bar width (in position axis units).
widthsrc – Sets the source reference on Chart Studio Cloud for
width.
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to layout.xaxis. If “x2”, the x
coordinates refer to layout.xaxis2, and so on.
xhoverformat – Sets the hover text formatting rulefor x 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*By default the values are
formatted using xaxis.hoverformat.
xperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
xperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When x0period is round number
of weeks, the x0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
xsrc – Sets the source reference on Chart Studio Cloud for
x.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to layout.yaxis. If “y2”, the y
coordinates refer to layout.yaxis2, and so on.
yhoverformat – Sets the hover text formatting rulefor y 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*By default the values are
formatted using yaxis.hoverformat.
yperiod – Only relevant when the axis type is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case n
must be a positive integer.
yperiod0 – Only relevant when the axis type is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When y0period is round number
of weeks, the y0period0 by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.
yperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
ysrc – Sets the source reference on Chart Studio Cloud for
y.
zorder – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher zorder appear in front of those
with lower zorder.
row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
rows in the specified column(s).
col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be
added. Only valid if figure was created using
plotly.tools.make_subplots.If ‘all’, addresses all
columns in the specified row(s).
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:
The figure was created using
plotly.subplots.make_subplots.The row and col arguments are not None
The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.
for_each_annotation(fn, selector=None, row=None, col=None, secondary_y=None)¶Apply a function to all annotations that satisfy the specified selection criteria
fn – Function that inputs a single annotation object.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotations that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.
col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotations that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
If True, only select annotations associated with the secondary y-axis of the subplot.
If False, only select annotations associated with the primary y-axis of the subplot.
If None (the default), do not filter annotations based on secondary y-axis.
To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Returns the Figure object that the method was called on
self
for_each_coloraxis(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all coloraxis objects that satisfy the specified selection criteria
fn – Function that inputs a single coloraxis object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
Returns the Figure object that the method was called on
self
for_each_geo(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all geo objects that satisfy the specified selection criteria
fn – Function that inputs a single geo object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.
col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.
Returns the Figure object that the method was called on
self
for_each_layout_image(fn, selector=None, row=None, col=None, secondary_y=None)¶Apply a function to all images that satisfy the specified selection criteria
fn – Function that inputs a single image object.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those images that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.
col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those images that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
If True, only select images associated with the secondary y-axis of the subplot.
If False, only select images associated with the primary y-axis of the subplot.
If None (the default), do not filter images based on secondary y-axis.
To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Returns the Figure object that the method was called on
self
for_each_legend(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all legend objects that satisfy the specified selection criteria
fn – Function that inputs a single legend object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.
col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.
Returns the Figure object that the method was called on
self
for_each_map(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all map objects that satisfy the specified selection criteria
fn – Function that inputs a single map object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.
col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.
Returns the Figure object that the method was called on
self
for_each_mapbox(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all mapbox objects that satisfy the specified selection criteria
fn – Function that inputs a single mapbox object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.
col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.
Returns the Figure object that the method was called on
self
for_each_polar(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all polar objects that satisfy the specified selection criteria
fn – Function that inputs a single polar object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.
col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.
Returns the Figure object that the method was called on
self
for_each_scene(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all scene objects that satisfy the specified selection criteria
fn – Function that inputs a single scene object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.
col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.
Returns the Figure object that the method was called on
self
for_each_selection(fn, selector=None, row=None, col=None, secondary_y=None)¶Apply a function to all selections that satisfy the specified selection criteria
fn – Function that inputs a single selection object.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selections that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.
col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selections that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.
secondary_y (boolean or None (default None)) –
If True, only select selections associated with the secondary y-axis of the subplot.
If False, only select selections associated with the primary y-axis of the subplot.
If None (the default), do not filter selections based on secondary y-axis.
To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Returns the Figure object that the method was called on
self
for_each_shape(fn, selector=None, row=None, col=None, secondary_y=None)¶Apply a function to all shapes that satisfy the specified selection criteria
fn – Function that inputs a single shape object.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shapes that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.
col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shapes that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
If True, only select shapes associated with the secondary y-axis of the subplot.
If False, only select shapes associated with the primary y-axis of the subplot.
If None (the default), do not filter shapes based on secondary y-axis.
To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Returns the Figure object that the method was called on
self
for_each_smith(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all smith objects that satisfy the specified selection criteria
fn – Function that inputs a single smith object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.
col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.
Returns the Figure object that the method was called on
self
for_each_ternary(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all ternary objects that satisfy the specified selection criteria
fn – Function that inputs a single ternary object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.
col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.
Returns the Figure object that the method was called on
self
for_each_trace(fn, selector=None, row=None, col=None, secondary_y=None) → plotly.graph_objects._figure.Figure¶Apply a function to all traces that satisfy the specified selection criteria
fn – Function that inputs a single trace object.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all traces are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each trace and those for which the function returned True will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.
col (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.
secondary_y (boolean or None (default None)) –
If True, only select traces associated with the secondary y-axis of the subplot.
If False, only select traces associated with the primary y-axis of the subplot.
If None (the default), do not filter traces based on secondary y-axis.
To select traces by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Returns the Figure object that the method was called on
self
for_each_xaxis(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure¶Apply a function to all xaxis objects that satisfy the specified selection criteria
fn – Function that inputs a single xaxis object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.
col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.
Returns the Figure object that the method was called on
self
for_each_yaxis(fn, selector=None, row=None, col=None, secondary_y=None) → plotly.graph_objects._figure.Figure¶Apply a function to all yaxis objects that satisfy the specified selection criteria
fn – Function that inputs a single yaxis object.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.
col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
If True, only select yaxis objects associated with the secondary y-axis of the subplot.
If False, only select yaxis objects associated with the primary y-axis of the subplot.
If None (the default), do not filter yaxis objects based on a secondary y-axis condition.
To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Returns the Figure object that the method was called on
self
select_annotations(selector=None, row=None, col=None, secondary_y=None)¶Select annotations from a particular subplot cell and/or annotations that satisfy custom selection criteria.
selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.
col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
If True, only select annotations associated with the secondary y-axis of the subplot.
If False, only select annotations associated with the primary y-axis of the subplot.
If None (the default), do not filter annotations based on secondary y-axis.
To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Generator that iterates through all of the annotations that satisfy all of the specified selection criteria
generator
select_coloraxes(selector=None, row=None, col=None)¶Select coloraxis subplot objects from a particular subplot cell and/or coloraxis subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
Generator that iterates through all of the coloraxis objects that satisfy all of the specified selection criteria
generator
select_geos(selector=None, row=None, col=None)¶Select geo subplot objects from a particular subplot cell and/or geo subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.
col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.
Generator that iterates through all of the geo objects that satisfy all of the specified selection criteria
generator
select_layout_images(selector=None, row=None, col=None, secondary_y=None)¶Select images from a particular subplot cell and/or images that satisfy custom selection criteria.
selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.
col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
If True, only select images associated with the secondary y-axis of the subplot.
If False, only select images associated with the primary y-axis of the subplot.
If None (the default), do not filter images based on secondary y-axis.
To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Generator that iterates through all of the images that satisfy all of the specified selection criteria
generator
select_legends(selector=None, row=None, col=None)¶Select legend subplot objects from a particular subplot cell and/or legend subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.
col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.
Generator that iterates through all of the legend objects that satisfy all of the specified selection criteria
generator
select_mapboxes(selector=None, row=None, col=None)¶Select mapbox subplot objects from a particular subplot cell and/or mapbox subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.
col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.
Generator that iterates through all of the mapbox objects that satisfy all of the specified selection criteria
generator
select_maps(selector=None, row=None, col=None)¶Select map subplot objects from a particular subplot cell and/or map subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.
col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.
Generator that iterates through all of the map objects that satisfy all of the specified selection criteria
generator
select_polars(selector=None, row=None, col=None)¶Select polar subplot objects from a particular subplot cell and/or polar subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.
col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.
Generator that iterates through all of the polar objects that satisfy all of the specified selection criteria
generator
select_scenes(selector=None, row=None, col=None)¶Select scene subplot objects from a particular subplot cell and/or scene subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.
col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.
Generator that iterates through all of the scene objects that satisfy all of the specified selection criteria
generator
select_selections(selector=None, row=None, col=None, secondary_y=None)¶Select selections from a particular subplot cell and/or selections that satisfy custom selection criteria.
selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.
col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.
secondary_y (boolean or None (default None)) –
If True, only select selections associated with the secondary y-axis of the subplot.
If False, only select selections associated with the primary y-axis of the subplot.
If None (the default), do not filter selections based on secondary y-axis.
To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Generator that iterates through all of the selections that satisfy all of the specified selection criteria
generator
select_shapes(selector=None, row=None, col=None, secondary_y=None)¶Select shapes from a particular subplot cell and/or shapes that satisfy custom selection criteria.
selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.
col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
If True, only select shapes associated with the secondary y-axis of the subplot.
If False, only select shapes associated with the primary y-axis of the subplot.
If None (the default), do not filter shapes based on secondary y-axis.
To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Generator that iterates through all of the shapes that satisfy all of the specified selection criteria
generator
select_smiths(selector=None, row=None, col=None)¶Select smith subplot objects from a particular subplot cell and/or smith subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.
col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.
Generator that iterates through all of the smith objects that satisfy all of the specified selection criteria
generator
select_ternaries(selector=None, row=None, col=None)¶Select ternary subplot objects from a particular subplot cell and/or ternary subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.
col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.
Generator that iterates through all of the ternary objects that satisfy all of the specified selection criteria
generator
select_xaxes(selector=None, row=None, col=None)¶Select xaxis subplot objects from a particular subplot cell and/or xaxis subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.
col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.
Generator that iterates through all of the xaxis objects that satisfy all of the specified selection criteria
generator
select_yaxes(selector=None, row=None, col=None, secondary_y=None)¶Select yaxis subplot objects from a particular subplot cell and/or yaxis subplot objects that satisfy custom selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.
row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.
col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
If True, only select yaxis objects associated with the secondary y-axis of the subplot.
If False, only select yaxis objects associated with the primary y-axis of the subplot.
If None (the default), do not filter yaxis objects based on a secondary y-axis condition.
To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
Generator that iterates through all of the yaxis objects that satisfy all of the specified selection criteria
generator
set_subplots(rows=None, cols=None, **make_subplots_args) → plotly.graph_objects._figure.Figure¶Add subplots to this figure. If the figure already contains subplots, then this throws an error. Accepts any keyword arguments that plotly.subplots.make_subplots accepts.
update(dict1=None, overwrite=False, **kwargs) → plotly.graph_objects._figure.Figure¶Update the properties of the figure with a dict and/or with keyword arguments.
This recursively updates the structure of the figure object with the values in the input dict / keyword arguments.
dict1 (dict) – Dictionary of properties to be updated
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
kwargs – Keyword/value pair of properties to be updated
Examples
>>> import plotly.graph_objects as go
>>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
>>> fig.update(data=[{'y': [4, 5, 6]}])
Figure(...)
>>> fig.to_plotly_json()
{'data': [{'type': 'scatter',
'uid': 'e86a7c7a-346a-11e8-8aa8-a0999b0c017b',
'y': array([4, 5, 6], dtype=int32)}],
'layout': {}}
>>> fig = go.Figure(layout={'xaxis':
... {'color': 'green',
... 'range': [0, 1]}})
>>> fig.update({'layout': {'xaxis': {'color': 'pink'}}})
Figure(...)
>>> fig.to_plotly_json()
{'data': [],
'layout': {'xaxis':
{'color': 'pink',
'range': [0, 1]}}}
Updated figure
update_annotations(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all annotations that satisfy the specified selection criteria
patch (dict or None (default None)) – Dictionary of property updates to be applied to all annotations that satisfy the selection criteria.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.
col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
If True, only select annotations associated with the secondary y-axis of the subplot.
If False, only select annotations associated with the primary y-axis of the subplot.
If None (the default), do not filter annotations based on secondary y-axis.
To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
**kwargs – Additional property updates to apply to each selected annotation. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_coloraxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all coloraxis objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all coloraxis objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
**kwargs – Additional property updates to apply to each selected coloraxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_geos(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all geo objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all geo objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.
col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.
**kwargs – Additional property updates to apply to each selected geo object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_layout(dict1=None, overwrite=False, **kwargs) → plotly.graph_objects._figure.Figure¶Update the properties of the figure’s layout with a dict and/or with keyword arguments.
This recursively updates the structure of the original layout with the values in the input dict / keyword arguments.
dict1 (dict) – Dictionary of properties to be updated
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
kwargs – Keyword/value pair of properties to be updated
The Figure object that the update_layout method was called on
update_layout_images(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all images that satisfy the specified selection criteria
patch (dict or None (default None)) – Dictionary of property updates to be applied to all images that satisfy the selection criteria.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.
col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
If True, only select images associated with the secondary y-axis of the subplot.
If False, only select images associated with the primary y-axis of the subplot.
If None (the default), do not filter images based on secondary y-axis.
To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
**kwargs – Additional property updates to apply to each selected image. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_legends(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all legend objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all legend objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.
col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.
**kwargs – Additional property updates to apply to each selected legend object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_mapboxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all mapbox objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all mapbox objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.
col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.
**kwargs – Additional property updates to apply to each selected mapbox object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_maps(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all map objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all map objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.
col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.
**kwargs – Additional property updates to apply to each selected map object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_polars(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all polar objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all polar objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.
col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.
**kwargs – Additional property updates to apply to each selected polar object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_scenes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all scene objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all scene objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.
col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.
**kwargs – Additional property updates to apply to each selected scene object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_selections(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all selections that satisfy the specified selection criteria
patch (dict or None (default None)) – Dictionary of property updates to be applied to all selections that satisfy the selection criteria.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.
col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.
secondary_y (boolean or None (default None)) –
If True, only select selections associated with the secondary y-axis of the subplot.
If False, only select selections associated with the primary y-axis of the subplot.
If None (the default), do not filter selections based on secondary y-axis.
To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
**kwargs – Additional property updates to apply to each selected selection. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_shapes(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all shapes that satisfy the specified selection criteria
patch (dict or None (default None)) – Dictionary of property updates to be applied to all shapes that satisfy the selection criteria.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.
col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
If True, only select shapes associated with the secondary y-axis of the subplot.
If False, only select shapes associated with the primary y-axis of the subplot.
If None (the default), do not filter shapes based on secondary y-axis.
To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
**kwargs – Additional property updates to apply to each selected shape. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_smiths(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all smith objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all smith objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.
col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.
**kwargs – Additional property updates to apply to each selected smith object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_ternaries(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all ternary objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all ternary objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.
col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.
**kwargs – Additional property updates to apply to each selected ternary object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_traces(patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all traces that satisfy the specified selection criteria
patch (dict or None (default None)) – Dictionary of property updates to be applied to all traces that satisfy the selection criteria.
selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all traces are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each trace and those for which the function returned True will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).
row (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.
col (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.
secondary_y (boolean or None (default None)) –
If True, only select traces associated with the secondary y-axis of the subplot.
If False, only select traces associated with the primary y-axis of the subplot.
If None (the default), do not filter traces based on secondary y-axis.
To select traces by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
**kwargs – Additional property updates to apply to each selected trace. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_xaxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all xaxis objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all xaxis objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.
col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.
**kwargs – Additional property updates to apply to each selected xaxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
update_yaxes(patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure¶Perform a property update operation on all yaxis objects that satisfy the specified selection criteria
patch (dict) – Dictionary of property updates to be applied to all yaxis objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.
col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
If True, only select yaxis objects associated with the secondary y-axis of the subplot.
If False, only select yaxis objects associated with the primary y-axis of the subplot.
If None (the default), do not filter yaxis objects based on a secondary y-axis condition.
To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.
**kwargs – Additional property updates to apply to each selected yaxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
Returns the Figure object that the method was called on
self
plotly.graph_objects.FigureWidget(*args, **kwargs)¶Bases: plotly.basedatatypes.BaseFigure
FigureWidget stand-in for use when anywidget is not installed. The only purpose
of this class is to provide something to import as
plotly.graph_objects.FigureWidget when anywidget is not installed. This class
simply raises an informative error message when the constructor is called
plotly.graph_objects.Font(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Font is deprecated.
plotly.graph_objects.layout.Font
plotly.graph_objects.layout.hoverlabel.Font
etc.
plotly.graph_objects.Frame(arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)¶Bases: plotly.basedatatypes.BaseFrameHierarchyType
baseframe¶The name of the frame into which this frame’s properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames.
A string
A number that will be converted to a string
data¶A list of traces this frame modifies. The format is identical to the normal trace definition.
Any
group¶An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames.
A string
A number that will be converted to a string
layout¶Layout properties which this frame modifies. The format is identical to the normal layout definition.
Any
name¶A label by which to identify the frame
A string
A number that will be converted to a string
traces¶A list of trace indices that identify the respective traces in the data attribute
The ‘traces’ property accepts values of any type
Any
plotly.graph_objects.Frames(*args, **kwargs)¶Bases: list
plotly.graph_objects.Frames is deprecated.
plotly.graph_objects.Frame
plotly.graph_objects.Funnel(arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
cliponaxis¶Determines whether the text nodes are clipped about the subplot
axes. To show the text nodes above axis lines and tick labels,
make sure to set xaxis.layer and yaxis.layer to below
traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
connector¶The ‘connector’ property is an instance of Connector that may be specified as:
An instance of
plotly.graph_objects.funnel.ConnectorA dict of string/value properties that will be passed to the Connector constructor
Supported dict properties:
- fillcolor
Sets the fill color.
- line
plotly.graph_objects.funnel.connector.L ineinstance or dict with compatible properties- visible
Determines if connector regions and lines are drawn.
constraintext¶Constrain the size of text inside or outside a bar to be no larger than the bar itself.
[‘inside’, ‘outside’, ‘both’, ‘none’]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘name’, ‘x’, ‘y’, ‘text’, ‘percent initial’, ‘percent previous’, ‘percent total’] joined with ‘+’ characters (e.g. ‘name+x’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.funnel.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables percentInitial,
percentPrevious and percentTotal. Anything contained in tag
<extra> is displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextanchor¶Determines if texts are kept at center or start/end points in
textposition “inside” mode.
[‘end’, ‘middle’, ‘start’]
Any
insidetextfont¶Sets the font used for text lying inside the bar.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.funnel.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
legend¶Sets the reference to a legend to show this trace 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 trace. 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.funnel.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.funnel.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.funnel.marker.Colo rBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- line
:class:`plotly.graph_objects.funnel.marker.Line ` instance or dict with compatible properties
- opacity
Sets the opacity of the bars.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
offset¶Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.
An int or float
int|float
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶Sets the orientation of the funnels. With “v” (“h”), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only “y” array is presented or orientation is set to “v”. Also regarding graphs including only ‘horizontal’ funnels, “autorange” on the “y-axis” are set to “reversed”.
[‘v’, ‘h’]
Any
outsidetextfont¶Sets the font used for text lying outside the bar.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.funnel.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.funnel.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textangle¶Sets the angle of the tick labels with respect to the bar. For
example, a tickangle of -90 draws the tick labels vertically.
With “auto” the texts may automatically be rotated to fit with
the maximum size in bars.
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
textfont¶Sets the font used for text.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.funnel.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘percent initial’, ‘percent previous’, ‘percent total’, ‘value’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textposition¶Specifies the location of the text. “inside” positions text
inside, next to the bar end (rotated and scaled if needed).
“outside” positions text outside, next to the bar end (scaled
if needed), unless there is another bar stacked on this one,
then the text gets pushed inside. “auto” tries to position
text inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If “none”, no
text appears.
[‘inside’, ‘outside’, ‘auto’, ‘none’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables
percentInitial, percentPrevious, percentTotal, label
and value.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
width¶Sets the bar width (in position axis units).
An int or float in the interval [0, inf]
int|float
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Funnelarea(arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
aspectratio¶Sets the ratio between height and width
An int or float in the interval [0, inf]
int|float
baseratio¶Sets the ratio between bottom length and maximum top length.
An int or float in the interval [0, 1]
int|float
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dlabel¶Sets the label step. See label0 for more info.
An int or float
int|float
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.funnelarea.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .
- row
If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .
- x
Sets the horizontal domain of this funnelarea trace (in plot fraction).
- y
Sets the vertical domain of this funnelarea trace (in plot fraction).
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘percent’, ‘name’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.funnelarea.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables label, color,
value, text and percent. Anything contained in tag
<extra> is displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each sector. If a
single string, the same string appears for all data points. If
an array of string, the items are mapped in order of this
trace’s sectors. To be seen, trace hoverinfo must contain a
“text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextfont¶Sets the font used for textinfo lying inside the sector.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.funnelarea.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
label0¶Alternate to labels. Builds a numeric set of labels. Use with
dlabel where label0 is the starting label and dlabel the
step.
An int or float
int|float
labels¶Sets the sector labels. If labels entries are duplicated, we
sum associated values or simply count occurrences if values
is not provided. For other array attributes (including color)
we use the first non-empty entry among all occurrences of the
label.
The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
labelssrc¶Sets the source reference on Chart Studio Cloud for labels.
The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.funnelarea.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.funnelarea.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- colors
Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
- colorssrc
Sets the source reference on Chart Studio Cloud for
colors.- line
plotly.graph_objects.funnelarea.marker. Lineinstance or dict with compatible properties- pattern
Sets the pattern within the marker.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
scalegroup¶If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
A string
A number that will be converted to a string
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.funnelarea.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each sector. If trace
textinfo contains a “text” flag, these elements will be seen
on the chart. If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in the
hover labels.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶Sets the font used for textinfo.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.funnelarea.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph.
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘percent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textposition¶Specifies the location of the textinfo.
[‘inside’, ‘none’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables label,
color, value, text and percent.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.funnelarea.TitleA dict of string/value properties that will be passed to the Title constructor
Supported dict properties:
- font
Sets the font used for
title.- position
Specifies the location of the
title.- text
Sets the title of the chart. If it is empty, no title is displayed.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
values¶Sets the values of the sectors. If omitted, we count occurrences of each label.
The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuessrc¶Sets the source reference on Chart Studio Cloud for values.
The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Heatmap(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.heatmap.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.heatmap .colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.heatmap.colorbar.tickformatstopdefaults), sets the default property values to use for elements of heatmap.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.heatmap.colorbar.T itleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values)
in the z data are filled in. It is defaulted to true if z
is a one dimensional array and zsmooth is not false;
otherwise it is defaulted to false.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.heatmap.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoverongaps¶Determines whether or not gaps (i.e. {nan} or missing values)
in the z data have hover labels associated with them.
The ‘hoverongaps’ property must be specified as a bool (either True, or False)
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
The ‘hovertext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.heatmap.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.heatmap.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each z value.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.heatmap.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables x, y,
z and text.
A string
A number that will be converted to a string
transpose¶Transposes the z data.
The ‘transpose’ property must be specified as a bool (either True, or False)
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xgap¶Sets the horizontal gap (in pixels) between bricks.
An int or float in the interval [0, inf]
int|float
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
xtype¶If “array”, the heatmap’s x coordinates are given by “x” (the
default behavior when x is provided). If “scaled”, the
heatmap’s x coordinates are given by “x0” and “dx” (the default
behavior when x is not provided).
[‘array’, ‘scaled’]
Any
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
ygap¶Sets the vertical gap (in pixels) between bricks.
An int or float in the interval [0, inf]
int|float
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ytype¶If “array”, the heatmap’s y coordinates are given by “y” (the
default behavior when y is provided) If “scaled”, the
heatmap’s y coordinates are given by “y0” and “dy” (the default
behavior when y is not provided)
[‘array’, ‘scaled’]
Any
z¶Sets the z data.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zhoverformat¶Sets the hover text formatting rulefor z 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
zsmooth¶Picks a smoothing algorithm use to smooth z data.
[‘fast’, ‘best’, False]
Any
plotly.graph_objects.Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
autobinx¶since v1.42 each bin attribute is auto-determined
separately and autobinx is not needed. However, we accept
autobinx: true or false and will update xbins accordingly
before deleting autobinx from the trace.
The ‘autobinx’ property must be specified as a bool (either True, or False)
Obsolete
autobiny¶since v1.42 each bin attribute is auto-determined
separately and autobiny is not needed. However, we accept
autobiny: true or false and will update ybins accordingly
before deleting autobiny from the trace.
The ‘autobiny’ property must be specified as a bool (either True, or False)
Obsolete
bingroup¶Set a group of histogram traces which will have compatible bin
settings. Note that traces on the same subplot and with the
same “orientation” under barmode “stack”, “relative” and
“group” are forced into the same bingroup, Using bingroup,
traces under barmode “overlay” and on different axes (of the
same axis type) can have compatible bin settings. Note that
histogram and histogram2d* trace can share the same bingroup
A string
A number that will be converted to a string
cliponaxis¶Determines whether the text nodes are clipped about the subplot
axes. To show the text nodes above axis lines and tick labels,
make sure to set xaxis.layer and yaxis.layer to below
traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
constraintext¶Constrain the size of text inside or outside a bar to be no larger than the bar itself.
[‘inside’, ‘outside’, ‘both’, ‘none’]
Any
cumulative¶The ‘cumulative’ property is an instance of Cumulative that may be specified as:
An instance of
plotly.graph_objects.histogram.CumulativeA dict of string/value properties that will be passed to the Cumulative constructor
Supported dict properties:
- currentbin
Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. “include” is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. “exclude” makes the opposite half- bin bias, and “half” removes it.
- direction
Only applies if cumulative is enabled. If “increasing” (default) we sum all prior bins, so the result increases from left to right. If “decreasing” we sum later bins so the result decreases from left to right.
- enabled
If true, display the cumulative distribution by summing the binned values. Use the
directionandcentralbinattributes to tune the accumulation method. Note: in this mode, the “density”histnormsettings behave the same as their equivalents without “density”: “” and “density” both rise to the number of data points, and “probability” and probability density both rise to the number of sample points.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
error_x¶The ‘error_x’ property is an instance of ErrorX that may be specified as:
An instance of
plotly.graph_objects.histogram.ErrorXA dict of string/value properties that will be passed to the ErrorX constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
copy_ystyle
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
error_y¶The ‘error_y’ property is an instance of ErrorY that may be specified as:
An instance of
plotly.graph_objects.histogram.ErrorYA dict of string/value properties that will be passed to the ErrorY constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
histfunc¶Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
[‘count’, ‘sum’, ‘avg’, ‘min’, ‘max’]
Any
histnorm¶Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
[‘’, ‘percent’, ‘probability’, ‘density’, ‘probability density’]
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.histogram.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variable binNumber Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextanchor¶Determines if texts are kept at center or start/end points in
textposition “inside” mode.
[‘end’, ‘middle’, ‘start’]
Any
insidetextfont¶Sets the font used for text lying inside the bar.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.histogram.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
legend¶Sets the reference to a legend to show this trace 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 trace. 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.histogram.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.histogram.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.histogram.marker.C olorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- cornerradius
Sets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to
layout.barcornerradius. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.- line
plotly.graph_objects.histogram.marker.L ineinstance or dict with compatible properties- opacity
Sets the opacity of the bars.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- pattern
Sets the pattern within the marker.
- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
nbinsx¶Specifies the maximum number of desired bins. This value will
be used in an algorithm that will decide the optimal bin size
such that the histogram best visualizes the distribution of the
data. Ignored if xbins.size is provided.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
nbinsy¶Specifies the maximum number of desired bins. This value will
be used in an algorithm that will decide the optimal bin size
such that the histogram best visualizes the distribution of the
data. Ignored if ybins.size is provided.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
[‘v’, ‘h’]
Any
outsidetextfont¶Sets the font used for text lying outside the bar.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.histogram.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.histogram.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.histogram.selected .Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.histogram.selected .Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.histogram.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.
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
textangle¶Sets the angle of the tick labels with respect to the bar. For
example, a tickangle of -90 draws the tick labels vertically.
With “auto” the texts may automatically be rotated to fit with
the maximum size in bars.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.histogram.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
textposition¶Specifies the location of the text. “inside” positions text
inside, next to the bar end (rotated and scaled if needed).
“outside” positions text outside, next to the bar end (scaled
if needed), unless there is another bar stacked on this one,
then the text gets pushed inside. “auto” tries to position
text inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If “none”, no
text appears.
[‘inside’, ‘outside’, ‘auto’, ‘none’]
Any
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables label
and value.
A string
A number that will be converted to a string
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.histogram.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.histogram.unselect ed.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.histogram.unselect ed.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the sample data to be binned on the x axis.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xbins¶The ‘xbins’ property is an instance of XBins that may be specified as:
An instance of
plotly.graph_objects.histogram.XBinsA dict of string/value properties that will be passed to the XBins constructor
Supported dict properties:
- end
Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by
sizefromstartuntil we reach or exceedend. Defaults to the maximum data value. Likestart, for dates use a date string, and for category dataendis based on the category serial numbers.- size
Sets the size of each x axis bin. Default behavior: If
nbinsxis 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. Ifnbinsxis provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as inaxis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicitsizeis used and all others discarded. If nosizeis provided,the sample data from all traces is combined to determinesizeas described above.- start
Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a
sizeof 5 would have a defaultstartof -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, andstartshould be a date string. For category data,startis based on the category serial numbers, and defaults to -0.5. If multiple non- overlaying histograms share a subplot, the first explicitstartis used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the sample data to be binned on the y axis.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ybins¶The ‘ybins’ property is an instance of YBins that may be specified as:
An instance of
plotly.graph_objects.histogram.YBinsA dict of string/value properties that will be passed to the YBins constructor
Supported dict properties:
- end
Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by
sizefromstartuntil we reach or exceedend. Defaults to the maximum data value. Likestart, for dates use a date string, and for category dataendis based on the category serial numbers.- size
Sets the size of each y axis bin. Default behavior: If
nbinsyis 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. Ifnbinsyis provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as inaxis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicitsizeis used and all others discarded. If nosizeis provided,the sample data from all traces is combined to determinesizeas described above.- start
Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a
sizeof 5 would have a defaultstartof -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, andstartshould be a date string. For category data,startis based on the category serial numbers, and defaults to -0.5. If multiple non- overlaying histograms share a subplot, the first explicitstartis used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Histogram2d(arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
autobinx¶since v1.42 each bin attribute is auto-determined
separately and autobinx is not needed. However, we accept
autobinx: true or false and will update xbins accordingly
before deleting autobinx from the trace.
The ‘autobinx’ property must be specified as a bool (either True, or False)
Obsolete
autobiny¶since v1.42 each bin attribute is auto-determined
separately and autobiny is not needed. However, we accept
autobiny: true or false and will update ybins accordingly
before deleting autobiny from the trace.
The ‘autobiny’ property must be specified as a bool (either True, or False)
Obsolete
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)
bingroup¶Set the xbingroup and ybingroup default prefix For example,
setting a bingroup of 1 on two histogram2d traces will make
them their x-bins and y-bins match separately.
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.histogram2d.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.histogr am2d.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.histogram2d.colorbar.tickformatstopdefaults), sets the default property values to use for elements of histogram2d.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.histogram2d.colorb ar.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
histfunc¶Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
[‘count’, ‘sum’, ‘avg’, ‘min’, ‘max’]
Any
histnorm¶Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
[‘’, ‘percent’, ‘probability’, ‘density’, ‘probability density’]
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.histogram2d.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variable z Anything contained
in tag <extra> is displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.histogram2d.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.histogram2d.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- color
Sets the aggregation data.
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
nbinsx¶Specifies the maximum number of desired bins. This value will
be used in an algorithm that will decide the optimal bin size
such that the histogram best visualizes the distribution of the
data. Ignored if xbins.size is provided.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
nbinsy¶Specifies the maximum number of desired bins. This value will
be used in an algorithm that will decide the optimal bin size
such that the histogram best visualizes the distribution of the
data. Ignored if ybins.size is provided.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.histogram2d.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.histogram2d.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variable z
A string
A number that will be converted to a string
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the sample data to be binned on the x axis.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xbingroup¶Set a group of histogram traces which will have compatible
x-bin settings. Using xbingroup, histogram2d and
histogram2dcontour traces (on axes of the same axis type) can
have compatible x-bin settings. Note that the same xbingroup
value can be used to set (1D) histogram bingroup
A string
A number that will be converted to a string
xbins¶The ‘xbins’ property is an instance of XBins that may be specified as:
An instance of
plotly.graph_objects.histogram2d.XBinsA dict of string/value properties that will be passed to the XBins constructor
Supported dict properties:
- end
Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by
sizefromstartuntil we reach or exceedend. Defaults to the maximum data value. Likestart, for dates use a date string, and for category dataendis based on the category serial numbers.- size
Sets the size of each x axis bin. Default behavior: If
nbinsxis 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. Ifnbinsxis provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as inaxis.dtick. For category data, the number of categories to bin together (always defaults to 1).- start
Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a
sizeof 5 would have a defaultstartof -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, andstartshould be a date string. For category data,startis based on the category serial numbers, and defaults to -0.5.
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xgap¶Sets the horizontal gap (in pixels) between bricks.
An int or float in the interval [0, inf]
int|float
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the sample data to be binned on the y axis.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ybingroup¶Set a group of histogram traces which will have compatible
y-bin settings. Using ybingroup, histogram2d and
histogram2dcontour traces (on axes of the same axis type) can
have compatible y-bin settings. Note that the same ybingroup
value can be used to set (1D) histogram bingroup
A string
A number that will be converted to a string
ybins¶The ‘ybins’ property is an instance of YBins that may be specified as:
An instance of
plotly.graph_objects.histogram2d.YBinsA dict of string/value properties that will be passed to the YBins constructor
Supported dict properties:
- end
Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by
sizefromstartuntil we reach or exceedend. Defaults to the maximum data value. Likestart, for dates use a date string, and for category dataendis based on the category serial numbers.- size
Sets the size of each y axis bin. Default behavior: If
nbinsyis 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. Ifnbinsyis provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as inaxis.dtick. For category data, the number of categories to bin together (always defaults to 1).- start
Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a
sizeof 5 would have a defaultstartof -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, andstartshould be a date string. For category data,startis based on the category serial numbers, and defaults to -0.5.
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
ygap¶Sets the vertical gap (in pixels) between bricks.
An int or float in the interval [0, inf]
int|float
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the aggregation data.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zhoverformat¶Sets the hover text formatting rulefor z 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
zsmooth¶Picks a smoothing algorithm use to smooth z data.
[‘fast’, ‘best’, False]
Any
plotly.graph_objects.Histogram2dContour(arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
autobinx¶since v1.42 each bin attribute is auto-determined
separately and autobinx is not needed. However, we accept
autobinx: true or false and will update xbins accordingly
before deleting autobinx from the trace.
The ‘autobinx’ property must be specified as a bool (either True, or False)
Obsolete
autobiny¶since v1.42 each bin attribute is auto-determined
separately and autobiny is not needed. However, we accept
autobiny: true or false and will update ybins accordingly
before deleting autobiny from the trace.
The ‘autobiny’ property must be specified as a bool (either True, or False)
Obsolete
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)
autocontour¶Determines whether or not the contour level attributes are
picked by an algorithm. If True, the number of contour levels
can be set in ncontours. If False, set the contour level
attributes in contours.
The ‘autocontour’ property must be specified as a bool (either True, or False)
bingroup¶Set the xbingroup and ybingroup default prefix For example,
setting a bingroup of 1 on two histogram2d traces will make
them their x-bins and y-bins match separately.
A string
A number that will be converted to a string
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.histogr am2dcontour.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.histogram2dcontour.colorbar.tickformatstopdef aults), sets the default property values to use for elements of histogram2dcontour.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.histogram2dcontour .colorbar.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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 zmin and zmax.
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.
contours¶The ‘contours’ property is an instance of Contours that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.ContoursA dict of string/value properties that will be passed to the Contours constructor
Supported dict properties:
- coloring
Determines the coloring method showing the contour values. If “fill”, coloring is done evenly between each contour level If “heatmap”, a heatmap gradient coloring is applied between each contour level. If “lines”, coloring is done on the contour lines. If “none”, no coloring is applied on this trace.
- end
Sets the end contour level value. Must be more than
contours.start- labelfont
Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from
layout.font.- labelformat
Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
- operation
Sets the constraint operation. “=” keeps regions equal to
value“<” and “<=” keep regions less thanvalue“>” and “>=” keep regions greater thanvalue“[]”, “()”, “[)”, and “(]” keep regions insidevalue[0]tovalue[1]“][“, “)(“, “](“, “)[” keep regions outsidevalue[0]to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.- showlabels
Determines whether to label the contour lines with their values.
- showlines
Determines whether or not the contour lines are drawn. Has an effect only if
contours.coloringis set to “fill”.- size
Sets the step between each contour level. Must be positive.
- start
Sets the starting contour level value. Must be less than
contours.end- type
If
levels, the data is represented as a contour plot with multiple levels displayed. Ifconstraint, the data is represented as constraints with the invalid region shaded as specified by theoperationandvalueparameters.- value
Sets the value or values of the constraint boundary. When
operationis set to one of the comparison values (=,<,>=,>,<=) “value” is expected to be a number. Whenoperationis set to one of the interval values ([],(),[),(],][,)(,](,)[) “value” is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
histfunc¶Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
[‘count’, ‘sum’, ‘avg’, ‘min’, ‘max’]
Any
histnorm¶Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
[‘’, ‘percent’, ‘probability’, ‘density’, ‘probability density’]
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variable z Anything contained
in tag <extra> is displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.histogram2dcontour.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.histogram2dcontour.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the color of the contour level. Has no effect if
contours.coloringis set to “lines”.- dash
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”).
- smoothing
Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.
- width
Sets the contour line width in (in px)
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- color
Sets the aggregation data.
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
nbinsx¶Specifies the maximum number of desired bins. This value will
be used in an algorithm that will decide the optimal bin size
such that the histogram best visualizes the distribution of the
data. Ignored if xbins.size is provided.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
nbinsy¶Specifies the maximum number of desired bins. This value will
be used in an algorithm that will decide the optimal bin size
such that the histogram best visualizes the distribution of the
data. Ignored if ybins.size is provided.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
ncontours¶Sets the maximum number of contour levels. The actual number of
contours will be chosen automatically to be less than or equal
to the value of ncontours. Has an effect only if
autocontour is True or if contours.size is missing.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
reversescale¶Reverses the color mapping if true. If true, zmin will
correspond to the last color in the array and zmax will
correspond to the first color.
The ‘reversescale’ property must be specified as a bool (either True, or False)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
textfont¶For this trace it only has an effect if coloring is set to
“heatmap”. Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
texttemplate¶For this trace it only has an effect if coloring is set to
“heatmap”. Template string used for rendering the information
text that appear on points. Note that this will override
textinfo. Variables are inserted using %{variable}, for
example “y: %{y}”. Numbers are formatted using d3-format’s
syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables x, y,
z and text.
A string
A number that will be converted to a string
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the sample data to be binned on the x axis.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xbingroup¶Set a group of histogram traces which will have compatible
x-bin settings. Using xbingroup, histogram2d and
histogram2dcontour traces (on axes of the same axis type) can
have compatible x-bin settings. Note that the same xbingroup
value can be used to set (1D) histogram bingroup
A string
A number that will be converted to a string
xbins¶The ‘xbins’ property is an instance of XBins that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.XBinsA dict of string/value properties that will be passed to the XBins constructor
Supported dict properties:
- end
Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by
sizefromstartuntil we reach or exceedend. Defaults to the maximum data value. Likestart, for dates use a date string, and for category dataendis based on the category serial numbers.- size
Sets the size of each x axis bin. Default behavior: If
nbinsxis 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. Ifnbinsxis provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as inaxis.dtick. For category data, the number of categories to bin together (always defaults to 1).- start
Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a
sizeof 5 would have a defaultstartof -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, andstartshould be a date string. For category data,startis based on the category serial numbers, and defaults to -0.5.
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the sample data to be binned on the y axis.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ybingroup¶Set a group of histogram traces which will have compatible
y-bin settings. Using ybingroup, histogram2d and
histogram2dcontour traces (on axes of the same axis type) can
have compatible y-bin settings. Note that the same ybingroup
value can be used to set (1D) histogram bingroup
A string
A number that will be converted to a string
ybins¶The ‘ybins’ property is an instance of YBins that may be specified as:
An instance of
plotly.graph_objects.histogram2dcontour.YBinsA dict of string/value properties that will be passed to the YBins constructor
Supported dict properties:
- end
Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by
sizefromstartuntil we reach or exceedend. Defaults to the maximum data value. Likestart, for dates use a date string, and for category dataendis based on the category serial numbers.- size
Sets the size of each y axis bin. Default behavior: If
nbinsyis 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. Ifnbinsyis provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or “M<n>” for months, as inaxis.dtick. For category data, the number of categories to bin together (always defaults to 1).- start
Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a
sizeof 5 would have a defaultstartof -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, andstartshould be a date string. For category data,startis based on the category serial numbers, and defaults to -0.5.
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the aggregation data.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zauto¶Determines whether or not the color domain is computed with
respect to the input data (here in z) or the bounds set in
zmin and zmax Defaults to false when zmin and zmax
are set by the user.
The ‘zauto’ property must be specified as a bool (either True, or False)
zhoverformat¶Sets the hover text formatting rulefor z 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
zmax¶Sets the upper bound of the color domain. Value should have the
same units as in z and if set, zmin must be set as well.
An int or float
int|float
zmid¶Sets the mid-point of the color domain by scaling zmin and/or
zmax to be equidistant to this point. Value should have the
same units as in z. Has no effect when zauto is false.
An int or float
int|float
zmin¶Sets the lower bound of the color domain. Value should have the
same units as in z and if set, zmax must be set as well.
An int or float
int|float
plotly.graph_objects.Histogram2dcontour(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Histogram2dcontour is deprecated.
plotly.graph_objects.Histogram2dContour
plotly.graph_objects.Icicle(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
branchvalues¶Determines how the items in values are summed. When set to
“total”, items in values are taken to be value of all its
descendants. When set to “remainder”, items in values
corresponding to the root and the branches sectors are taken to
be the extra part not part of the sum of the values at their
leaves.
[‘remainder’, ‘total’]
Any
count¶Determines default for values when it is not provided, by
inferring a 1 for each of the “leaves” and/or “branches”,
otherwise 0.
The ‘count’ property is a flaglist and may be specified as a string containing:
Any combination of [‘branches’, ‘leaves’] joined with ‘+’ characters (e.g. ‘branches+leaves’)
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.icicle.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this icicle trace .
- row
If there is a layout grid, use the domain for this row in the grid for this icicle trace .
- x
Sets the horizontal domain of this icicle trace (in plot fraction).
- y
Sets the vertical domain of this icicle trace (in plot fraction).
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘name’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.icicle.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables currentPath, root,
entry, percentRoot, percentEntry and percentParent.
Anything contained in tag <extra> is displayed in the
secondary box, for example “<extra>{fullData.name}</extra>”. To
hide the secondary box completely, use an empty tag
<extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each sector. If a
single string, the same string appears for all data points. If
an array of string, the items are mapped in order of this
trace’s sectors. To be seen, trace hoverinfo must contain a
“text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextfont¶Sets the font used for textinfo lying inside the sector.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.icicle.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
labels¶Sets the labels of each of the sectors.
The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
labelssrc¶Sets the source reference on Chart Studio Cloud for labels.
The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
leaf¶The ‘leaf’ property is an instance of Leaf that may be specified as:
An instance of
plotly.graph_objects.icicle.LeafA dict of string/value properties that will be passed to the Leaf constructor
Supported dict properties:
- opacity
Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.icicle.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
level¶Sets the level from which this trace hierarchy is rendered. Set
level to '' to start from the root node in the hierarchy.
Must be an “id” if ids is filled in, otherwise plotly
attempts to find a matching item in labels.
The ‘level’ property accepts values of any type
Any
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.icicle.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if colors is set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in
marker.cminandmarker.cmaxHas an effect only if colors is set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set,
marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set,
marker.cmaxmust be set as well.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.icicle.marker.Colo rBarinstance or dict with compatible properties- colors
Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.
- colorscale
Sets the colorscale. Has an effect only if colors is set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorssrc
Sets the source reference on Chart Studio Cloud for
colors.- line
:class:`plotly.graph_objects.icicle.marker.Line ` instance or dict with compatible properties
- pattern
Sets the pattern within the marker.
- reversescale
Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true,
marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.
maxdepth¶Sets the number of rendered sectors from any given level. Set
maxdepth to “-1” to render all the levels in the hierarchy.
An int (or float that will be cast to an int)
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
outsidetextfont¶Sets the font used for textinfo lying outside the sector.
This option refers to the root of the hierarchy presented on
top left corner of a treemap graph. Please note that if a
hierarchy has multiple root nodes, this option won’t have any
effect and insidetextfont would be used.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.icicle.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
parents¶Sets the parent sectors for each of the sectors. Empty string
items ‘’ are understood to reference the root node in the
hierarchy. If ids is filled, parents items are understood
to be “ids” themselves. When ids is not set, plotly attempts
to find matching items in labels, but beware they must be
unique.
The ‘parents’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
parentssrc¶Sets the source reference on Chart Studio Cloud for parents.
The ‘parentssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
pathbar¶The ‘pathbar’ property is an instance of Pathbar that may be specified as:
An instance of
plotly.graph_objects.icicle.PathbarA dict of string/value properties that will be passed to the Pathbar constructor
Supported dict properties:
- edgeshape
Determines which shape is used for edges between
barpathlabels.- side
Determines on which side of the the treemap the
pathbarshould be presented.- textfont
Sets the font used inside
pathbar.- thickness
Sets the thickness of
pathbar(in px). If not specified thepathbar.textfont.sizeis used with 3 pixles extra padding on each side.- visible
Determines if the path bar is drawn i.e. outside the trace
domainand with one pixel gap.
root¶The ‘root’ property is an instance of Root that may be specified as:
An instance of
plotly.graph_objects.icicle.RootA dict of string/value properties that will be passed to the Root constructor
Supported dict properties:
- color
sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.
sort¶Determines whether or not the sectors are reordered from largest to smallest.
The ‘sort’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.icicle.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each sector. If trace
textinfo contains a “text” flag, these elements will be seen
on the chart. If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in the
hover labels.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶Sets the font used for textinfo.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.icicle.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph.
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textposition¶Sets the positions of the text elements.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
Any
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables
currentPath, root, entry, percentRoot, percentEntry,
percentParent, label and value.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tiling¶The ‘tiling’ property is an instance of Tiling that may be specified as:
An instance of
plotly.graph_objects.icicle.TilingA dict of string/value properties that will be passed to the Tiling constructor
Supported dict properties:
- flip
Determines if the positions obtained from solver are flipped on each axis.
- orientation
When set in conjunction with
tiling.flip, determines on which side the root nodes are drawn in the chart. Iftiling.orientationis “v” andtiling.flipis “”, the root nodes appear at the top. Iftiling.orientationis “v” andtiling.flipis “y”, the root nodes appear at the bottom. Iftiling.orientationis “h” andtiling.flipis “”, the root nodes appear at the left. Iftiling.orientationis “h” andtiling.flipis “x”, the root nodes appear at the right.- pad
Sets the inner padding (in px).
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
values¶Sets the values associated with each of the sectors. Use with
branchvalues to determine how the values are summed.
The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuessrc¶Sets the source reference on Chart Studio Cloud for values.
The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Image(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
colormodel¶Color model used to map the numerical color components
described in z into colors. If source is specified, this
attribute will be set to rgba256 otherwise it defaults to
rgb.
[‘rgb’, ‘rgba’, ‘rgba256’, ‘hsl’, ‘hsla’]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Set the pixel’s horizontal size.
An int or float
int|float
dy¶Set the pixel’s vertical size
An int or float
int|float
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘color’, ‘name’, ‘text’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.image.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables z, color and
colormodel. Anything contained in tag <extra> is displayed
in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
The ‘hovertext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.image.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
source¶Specifies the data URI of the image to be visualized. The URI consists of “data:image/[<media subtype>][;base64],<data>”
A string
A number that will be converted to a string
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.image.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each z value.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x0¶Set the image’s x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
y0¶Set the image’s y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
z¶A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zmax¶that the default value will depend on the colormodel. For the
rgb colormodel, it is [255, 255, 255]. For the rgba
colormodel, it is [255, 255, 255, 1]. For the rgba256
colormodel, it is [255, 255, 255, 255]. For the hsl
colormodel, it is [360, 100, 100]. For the hsla colormodel,
it is [360, 100, 100, 1].
The ‘zmax’ property is an info array that may be specified as:
a list or tuple of 4 elements where:
An int or float
An int or float
An int or float
An int or float
list
zmin¶that the default value will depend on the colormodel. For the
rgb colormodel, it is [0, 0, 0]. For the rgba colormodel,
it is [0, 0, 0, 0]. For the rgba256 colormodel, it is [0, 0,
0, 0]. For the hsl colormodel, it is [0, 0, 0]. For the
hsla colormodel, it is [0, 0, 0, 0].
The ‘zmin’ property is an info array that may be specified as:
a list or tuple of 4 elements where:
An int or float
An int or float
An int or float
An int or float
list
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
zsmooth¶Picks a smoothing algorithm used to smooth z data. This only
applies for image traces that use the source attribute.
[‘fast’, False]
Any
plotly.graph_objects.Indicator(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
align¶Sets the horizontal alignment of the text within the box.
Note that this attribute has no effect if an angular gauge is
displayed: in this case, it is always centered
[‘left’, ‘center’, ‘right’]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
delta¶The ‘delta’ property is an instance of Delta that may be specified as:
An instance of
plotly.graph_objects.indicator.DeltaA dict of string/value properties that will be passed to the Delta constructor
Supported dict properties:
- decreasing
plotly.graph_objects.indicator.delta.De creasinginstance or dict with compatible properties- font
Set the font used to display the delta
- increasing
plotly.graph_objects.indicator.delta.In creasinginstance or dict with compatible properties- position
Sets the position of delta with respect to the number.
- prefix
Sets a prefix appearing before the delta.
- reference
Sets the reference value to compute the delta. By default, it is set to the current value.
- relative
Show relative change
- suffix
Sets a suffix appearing next to the delta.
- valueformat
Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.indicator.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this indicator trace .
- row
If there is a layout grid, use the domain for this row in the grid for this indicator trace .
- x
Sets the horizontal domain of this indicator trace (in plot fraction).
- y
Sets the vertical domain of this indicator trace (in plot fraction).
gauge¶The gauge of the Indicator plot.
The ‘gauge’ property is an instance of Gauge that may be specified as:
An instance of
plotly.graph_objects.indicator.GaugeA dict of string/value properties that will be passed to the Gauge constructor
Supported dict properties:
- axis
plotly.graph_objects.indicator.gauge.Ax isinstance or dict with compatible properties- bar
Set the appearance of the gauge’s value
- bgcolor
Sets the gauge background color.
- bordercolor
Sets the color of the border enclosing the gauge.
- borderwidth
Sets the width (in px) of the border enclosing the gauge.
- shape
Set the shape of the gauge
- steps
A tuple of
plotly.graph_objects.indicat or.gauge.Stepinstances or dicts with compatible properties- stepdefaults
When used in a template (as layout.template.dat a.indicator.gauge.stepdefaults), sets the default property values to use for elements of indicator.gauge.steps
- threshold
plotly.graph_objects.indicator.gauge.Th resholdinstance or dict with compatible properties
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.indicator.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines how the value is displayed on the graph. number
displays the value numerically in text. delta displays the
difference to a reference value in text. Finally, gauge
displays the value graphically on an axis.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘number’, ‘delta’, ‘gauge’] joined with ‘+’ characters (e.g. ‘number+delta’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
number¶The ‘number’ property is an instance of Number that may be specified as:
An instance of
plotly.graph_objects.indicator.NumberA dict of string/value properties that will be passed to the Number constructor
Supported dict properties:
- font
Set the font used to display main number
- prefix
Sets a prefix appearing before the number.
- suffix
Sets a suffix appearing next to the number.
- valueformat
Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.indicator.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.indicator.TitleA dict of string/value properties that will be passed to the Title constructor
Supported dict properties:
- align
Sets the horizontal alignment of the title. It defaults to
centerexcept for bullet charts for which it defaults to right.- font
Set the font used to display the title
- text
Sets the title of this indicator.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
value¶Sets the number to be displayed.
An int or float
int|float
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Isosurface(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
caps¶The ‘caps’ property is an instance of Caps that may be specified as:
An instance of
plotly.graph_objects.isosurface.CapsA dict of string/value properties that will be passed to the Caps constructor
Supported dict properties:
- x
plotly.graph_objects.isosurface.caps.Xinstance or dict with compatible properties- y
plotly.graph_objects.isosurface.caps.Yinstance or dict with compatible properties- z
plotly.graph_objects.isosurface.caps.Zinstance or dict with compatible properties
cauto¶Determines whether or not the color domain is computed with
respect to the input data (here value) 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 value 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 value. 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 value and if set, cmax must be set as well.
An int or float
int|float
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.isosurface.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.isosurf ace.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.isosurface.colorbar.tickformatstopdefaults), sets the default property values to use for elements of isosurface.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.isosurface.colorba r.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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.
contour¶The ‘contour’ property is an instance of Contour that may be specified as:
An instance of
plotly.graph_objects.isosurface.ContourA dict of string/value properties that will be passed to the Contour constructor
Supported dict properties:
- color
Sets the color of the contour lines.
- show
Sets whether or not dynamic contours are shown on hover
- width
Sets the width of the contour lines.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
flatshading¶Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
The ‘flatshading’ property must be specified as a bool (either True, or False)
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.isosurface.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
isomax¶Sets the maximum boundary for iso-surface plot.
An int or float
int|float
isomin¶Sets the minimum boundary for iso-surface plot.
An int or float
int|float
legend¶Sets the reference to a legend to show this trace 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 trace. 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.isosurface.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lighting¶The ‘lighting’ property is an instance of Lighting that may be specified as:
An instance of
plotly.graph_objects.isosurface.LightingA dict of string/value properties that will be passed to the Lighting constructor
Supported dict properties:
- ambient
Ambient light increases overall color visibility but can wash out the image.
- diffuse
Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
lightposition¶The ‘lightposition’ property is an instance of Lightposition that may be specified as:
An instance of
plotly.graph_objects.isosurface.LightpositionA dict of string/value properties that will be passed to the Lightposition constructor
Supported dict properties:
- x
Numeric vector, representing the X coordinate for each vertex.
- y
Numeric vector, representing the Y coordinate for each vertex.
- z
Numeric vector, representing the Z coordinate for each vertex.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the surface. Please note that in the case
of using high opacity values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the webgl API. This behavior may be
improved in the near future and is subject to change.
An int or float in the interval [0, 1]
int|float
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)
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
slices¶The ‘slices’ property is an instance of Slices that may be specified as:
An instance of
plotly.graph_objects.isosurface.SlicesA dict of string/value properties that will be passed to the Slices constructor
Supported dict properties:
- x
plotly.graph_objects.isosurface.slices. Xinstance or dict with compatible properties- y
plotly.graph_objects.isosurface.slices. Yinstance or dict with compatible properties- z
plotly.graph_objects.isosurface.slices. Zinstance or dict with compatible properties
spaceframe¶The ‘spaceframe’ property is an instance of Spaceframe that may be specified as:
An instance of
plotly.graph_objects.isosurface.SpaceframeA dict of string/value properties that will be passed to the Spaceframe constructor
Supported dict properties:
- fill
Sets the fill ratio of the
spaceframeelements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greaterfillratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).- show
Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.isosurface.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
surface¶The ‘surface’ property is an instance of Surface that may be specified as:
An instance of
plotly.graph_objects.isosurface.SurfaceA dict of string/value properties that will be passed to the Surface constructor
Supported dict properties:
- count
Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
- fill
Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a
fillratio less than one would allow the creation of openings parallel to the edges.- pattern
Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is
allmeaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capitalA,B,C,DandEmay also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.- show
Hides/displays surfaces between minimum and maximum iso-values.
text¶Sets the text elements associated with the vertices. If trace
hoverinfo contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
value¶Sets the 4th dimension (value) of the vertices.
The ‘value’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuehoverformat¶Sets the hover text formatting rulefor value 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
valuesrc¶Sets the source reference on Chart Studio Cloud for value.
The ‘valuesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the X coordinates of the vertices on X axis.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the Y coordinates of the vertices on Y axis.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the Z coordinates of the vertices on Z axis.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
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)¶Bases: plotly.basedatatypes.BaseLayoutType
activeselection¶The ‘activeselection’ property is an instance of Activeselection that may be specified as:
An instance of
plotly.graph_objects.layout.ActiveselectionA dict of string/value properties that will be passed to the Activeselection constructor
Supported dict properties:
- fillcolor
Sets the color filling the active selection’ interior.
- opacity
Sets the opacity of the active selection.
activeshape¶The ‘activeshape’ property is an instance of Activeshape that may be specified as:
An instance of
plotly.graph_objects.layout.ActiveshapeA dict of string/value properties that will be passed to the Activeshape constructor
Supported dict properties:
- fillcolor
Sets the color filling the active shape’ interior.
- opacity
Sets the opacity of the active shape.
annotationdefaults¶When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations
The ‘annotationdefaults’ property is an instance of Annotation that may be specified as:
An instance of
plotly.graph_objects.layout.AnnotationA dict of string/value properties that will be passed to the Annotation constructor
Supported dict properties:
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.Annotation
A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor
Supported dict properties:
- align
Sets the horizontal alignment of the
textwithin the box. Has an effect only iftextspans two or more lines (i.e.textcontains one or more <br> HTML tags) or if an explicit width is set to override the text width.- arrowcolor
Sets the color of the annotation arrow.
- arrowhead
Sets the end annotation arrow head style.
- arrowside
Sets the annotation arrow head position.
- 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.- arrowwidth
Sets the width (in px) of annotation arrow line.
- ax
Sets the x component of the arrow tail about the arrow head. If
axrefispixel, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). Ifaxrefis notpixeland is exactly the same asxref, this is an absolute value on that axis, likex, specified in the same coordinates asxref.- 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
xposition refers to a x coordinate. If set to “paper”, thexposition 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.- ay
Sets the y component of the arrow tail about the arrow head. If
ayrefispixel, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). Ifayrefis notpixeland is exactly the same asyref, this is an absolute value on that axis, likey, specified in the same coordinates asyref.- 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
yposition refers to a y coordinate. If set to “paper”, theyposition 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.- bgcolor
Sets the background color of the annotation.
- bordercolor
Sets the color of the border enclosing the annotation
text.- borderpad
Sets the padding (in px) between the
textand the enclosing border.- borderwidth
Sets the width (in px) of the border enclosing the annotation
text.- 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
captureeventsis False unlesshovertextis provided. If you use the eventplotly_clickannotationwithouthovertextyou must explicitly enablecaptureevents.- clicktoshow
Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the
xandyvalues 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 differentxoryvalues, you can setxclickand/oryclick. This is useful for example to label the side of a bar. To label markers though,standoffis preferred overxclickandyclick.- font
Sets the annotation text font.
- height
Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.
- hoverlabel
plotly.graph_objects.layout.annotation. Hoverlabelinstance or dict with compatible properties- hovertext
Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.
- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- opacity
Sets the opacity of the annotation (text + arrow).
- showarrow
Determines whether or not the annotation is drawn with an arrow. If True,
textis placed near the arrow’s tail. If False,textlines up with thexandyprovided.- 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/ayvector, in contrast toxshift/yshiftwhich moves everything by this amount.- startarrowhead
Sets the start annotation arrow head style.
- 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.- 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/ayvector, in contrast toxshift/yshiftwhich moves everything by this amount.- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- 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.
- textangle
Sets the angle at which the
textis drawn with respect to the horizontal.- valign
Sets the vertical alignment of the
textwithin the box. Has an effect only if an explicit height is set to override the text height.- visible
Determines whether or not this annotation is visible.
- 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.
- x
Sets the annotation’s x position. If the axis
typeis “log”, then you must take the log of your desired range. If the axistypeis “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistypeis “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.- xanchor
Sets the text box’s horizontal position anchor This anchor binds the
xposition to the “left”, “center” or “right” of the annotation. For example, ifxis set to 1,xrefto “paper” andxanchorto “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.- xclick
Toggle this annotation when clicking a data point whose
xvalue isxclickrather than the annotation’sxvalue.- xref
Sets the annotation’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the
xposition refers to a x coordinate. If set to “paper”, thexposition 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.- xshift
Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.
- y
Sets the annotation’s y position. If the axis
typeis “log”, then you must take the log of your desired range. If the axistypeis “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistypeis “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.- yanchor
Sets the text box’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the annotation. For example, ifyis set to 1,yrefto “paper” andyanchorto “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.- yclick
Toggle this annotation when clicking a data point whose
yvalue isyclickrather than the annotation’syvalue.- yref
Sets the annotation’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the
yposition refers to a y coordinate. If set to “paper”, theyposition 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.- yshift
Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
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.
The ‘autosize’ property must be specified as a bool (either True, or False)
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.
[‘convert types’, ‘strict’]
Any
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 %).
The ‘barcornerradius’ property accepts values of any type
Any
bargap¶Sets the gap (in plot fraction) between bars of adjacent location coordinates.
An int or float in the interval [0, 1]
int|float
bargroupgap¶Sets the gap (in plot fraction) between bars of the same location coordinate.
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 “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.
[‘stack’, ‘group’, ‘overlay’, ‘relative’]
Any
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.
[‘’, ‘fraction’, ‘percent’]
Any
boxgap¶Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
boxgroupgap¶Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
calendar¶Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
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.
The ‘clickmode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘event’, ‘select’] joined with ‘+’ characters (e.g. ‘event+select’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
coloraxis¶The ‘coloraxis’ property is an instance of Coloraxis that may be specified as:
An instance of
plotly.graph_objects.layout.ColoraxisA dict of string/value properties that will be passed to the Coloraxis constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bycolorscale. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- 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
cminandcmaxDefaults tofalsewhencminandcmaxare set by the user.- cmax
Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set,
cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
cminand/orcmaxto be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect whencautoisfalse.- cmin
Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set,
cmaxmust be set as well.- colorbar
plotly.graph_objects.layout.coloraxis.C olorBarinstance or dict with compatible properties- 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, usecminandcmax. Alternatively,colorscalemay be a palette name string of the following list: Blac kbody,Bluered,Blues,Cividis,Earth,Electric,Gree ns,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,R eds,Viridis,YlGnBu,YlOrRd.- reversescale
Reverses the color mapping if true. If true,
cminwill correspond to the last color in the array andcmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace.
colorscale¶The ‘colorscale’ property is an instance of Colorscale that may be specified as:
An instance of
plotly.graph_objects.layout.ColorscaleA dict of string/value properties that will be passed to the Colorscale constructor
Supported dict properties:
- diverging
Sets the default diverging colorscale. Note that
autocolorscalemust be true for this attribute to work.- sequential
Sets the default sequential colorscale for positive values. Note that
autocolorscalemust be true for this attribute to work.- sequentialminus
Sets the default sequential colorscale for negative values. Note that
autocolorscalemust be true for this attribute to work.
colorway¶Sets the default trace colors.
The ‘colorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
computed¶Placeholder for exporting automargin-impacting values namely
margin.t, margin.b, margin.l and margin.r in “full-
json” mode.
The ‘computed’ property accepts values of any type
Any
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.
The ‘datarevision’ property accepts values of any type
Any
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.
[‘zoom’, ‘pan’, ‘select’, ‘lasso’, ‘drawclosedpath’, ‘drawopenpath’, ‘drawline’, ‘drawrect’, ‘drawcircle’, ‘orbit’, ‘turntable’, False]
Any
editrevision¶true`
configuration, other than trace names and axis titles. Defaults
to layout.uirevision.
The ‘editrevision’ property accepts values of any type
Any
Controls persistence of user-driven changes in `editable
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.
The ‘extendfunnelareacolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendiciclecolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendpiecolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendsunburstcolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendtreemapcolors’ property must be specified as a bool (either True, or False)
font¶Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.FontA dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
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.
The ‘funnelareacolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
funnelgap¶Sets the gap (in plot fraction) between bars of adjacent location coordinates.
An int or float in the interval [0, 1]
int|float
funnelgroupgap¶Sets the gap (in plot fraction) between bars of the same location coordinate.
An int or float in the interval [0, 1]
int|float
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.
[‘stack’, ‘group’, ‘overlay’]
Any
geo¶The ‘geo’ property is an instance of Geo that may be specified as:
An instance of
plotly.graph_objects.layout.GeoA dict of string/value properties that will be passed to the Geo constructor
Supported dict properties:
- bgcolor
Set the background color of the map
- center
plotly.graph_objects.layout.geo.Centerinstance or dict with compatible properties- coastlinecolor
Sets the coastline color.
- coastlinewidth
Sets the coastline stroke width (in px).
- countrycolor
Sets line color of the country boundaries.
- countrywidth
Sets line width (in px) of the country boundaries.
- domain
plotly.graph_objects.layout.geo.Domaininstance or dict with compatible properties- fitbounds
Determines if this subplot’s view settings are auto-computed to fit trace data. On scoped maps, setting
fitboundsleads tocenter.lonandcenter.latgetting auto-filled. On maps with a non-clipped projection, settingfitboundsleads tocenter.lon,center.lat, andprojection.rotation.longetting auto-filled. On maps with a clipped projection, settingfitboundsleads tocenter.lon,center.lat,projection.rotation.lon,projection.rotation.lat,lonaxis.rangeandlataxis.rangegetting auto-filled. If “locations”, only the trace’s visible locations are considered in thefitboundscomputations. If “geojson”, the entire trace inputgeojson(if provided) is considered in thefitboundscomputations, Defaults to False.- framecolor
Sets the color the frame.
- framewidth
Sets the stroke width (in px) of the frame.
- lakecolor
Sets the color of the lakes.
- landcolor
Sets the land mass color.
- lataxis
:class:`plotly.graph_objects.layout.geo.Lataxis ` instance or dict with compatible properties
- lonaxis
:class:`plotly.graph_objects.layout.geo.Lonaxis ` instance or dict with compatible properties
- oceancolor
Sets the ocean color
- projection
plotly.graph_objects.layout.geo.Project ioninstance or dict with compatible properties- 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.
- rivercolor
Sets color of the rivers.
- riverwidth
Sets the stroke width (in px) of the rivers.
- scope
Set the scope of the map.
- showcoastlines
Sets whether or not the coastlines are drawn.
- showcountries
Sets whether or not country boundaries are drawn.
- showframe
Sets whether or not a frame is drawn around the map.
- showlakes
Sets whether or not lakes are drawn.
- showland
Sets whether or not land masses are filled in color.
- showocean
Sets whether or not oceans are filled in color.
- showrivers
Sets whether or not rivers are drawn.
- showsubunits
Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
- subunitcolor
Sets the color of the subunits boundaries.
- subunitwidth
Sets the stroke width (in px) of the subunits boundaries.
- uirevision
Controls persistence of user-driven changes in the view (projection and center). Defaults to
layout.uirevision.- visible
Sets the default visibility of the base layers.
grid¶The ‘grid’ property is an instance of Grid that may be specified as:
An instance of
plotly.graph_objects.layout.GridA dict of string/value properties that will be passed to the Grid constructor
Supported dict properties:
- columns
The number of columns in the grid. If you provide a 2D
subplotsarray, the length of its longest row is used as the default. If you give anxaxesarray, 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.- domain
:class:`plotly.graph_objects.layout.grid.Domain ` instance or dict with compatible properties
- pattern
If no
subplots,xaxes, oryaxesare given but we do haverowsandcolumns, 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 toroworder.- roworder
Is the first row the top or the bottom? Note that columns are always enumerated from left to right.
- rows
The number of rows in the grid. If you provide a 2D
subplotsarray or ayaxesarray, 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.- 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
domaincan place themselves in this grid separately using thegridcellattribute.- xaxes
Used with
yaxeswhen 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 ifsubplotsis present. If missing butyaxesis present, will generate consecutive IDs.- 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.
- 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.
- yaxes
Used with
yaxeswhen 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 ifsubplotsis present. If missing butxaxesis present, will generate consecutive IDs.- 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.
- 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.
height¶Sets the plot’s height (in px).
An int or float in the interval [10, inf]
int|float
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
The ‘hiddenlabels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
Sets the source reference on Chart Studio Cloud for
hiddenlabels.
The ‘hiddenlabelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
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).
The ‘hidesources’ property must be specified as a bool (either True, or False)
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.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.layout.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- bgcolor
Sets the background color of all hover labels on graph
- bordercolor
Sets the border color of all hover labels on graph.
- font
Sets the default hover label font used by all traces on the graph.
- grouptitlefont
Sets the font for group titles in hover (unified modes). Defaults to
hoverlabel.font.- 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 - 3characters and add an ellipsis.
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.
[‘x’, ‘y’, ‘closest’, False, ‘x unified’, ‘y unified’]
Any
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.
[‘single’, ‘overlaying’, ‘axis’]
Any
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.
The ‘iciclecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
imagedefaults¶When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images
The ‘imagedefaults’ property is an instance of Image that may be specified as:
An instance of
plotly.graph_objects.layout.ImageA dict of string/value properties that will be passed to the Image constructor
Supported dict properties:
images¶The ‘images’ property is a tuple of instances of Image that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Image
A list or tuple of dicts of string/value properties that will be passed to the Image constructor
Supported dict properties:
- layer
Specifies whether images are drawn below or above traces. When
xrefandyrefare both set topaper, image is drawn below the entire plot area.- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- opacity
Sets the opacity of the image.
- sizex
Sets the image container size horizontally. The image will be sized based on the
positionvalue. Whenxrefis set topaper, units are sized relative to the plot width. Whenxrefends with ` domain`, units are sized relative to the axis width.- sizey
Sets the image container size vertically. The image will be sized based on the
positionvalue. Whenyrefis set topaper, units are sized relative to the plot height. Whenyrefends with ` domain`, units are sized relative to the axis height.- sizing
Specifies which dimension of the image to constrain.
- 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.
- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- visible
Determines whether or not this image is visible.
- x
Sets the image’s x position. When
xrefis set topaper, units are sized relative to the plot height. Seexreffor more info- xanchor
Sets the anchor for the x position
- xref
Sets the images’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the
xposition refers to a x coordinate. If set to “paper”, thexposition 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.- y
Sets the image’s y position. When
yrefis set topaper, units are sized relative to the plot height. Seeyreffor more info- yanchor
Sets the anchor for the y position.
- yref
Sets the images’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the
yposition refers to a y coordinate. If set to “paper”, theyposition 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.
legend¶The ‘legend’ property is an instance of Legend that may be specified as:
An instance of
plotly.graph_objects.layout.LegendA dict of string/value properties that will be passed to the Legend constructor
Supported dict properties:
- bgcolor
Sets the legend background color. Defaults to
layout.paper_bgcolor.- bordercolor
Sets the color of the border enclosing the legend.
- borderwidth
Sets the width (in px) of the border enclosing the legend.
- entrywidth
Sets the width (in px or fraction) of the legend. Use 0 to size the entry based on the text width, when
entrywidthmodeis set to “pixels”.- entrywidthmode
Determines what entrywidth means.
- font
Sets the font used to text the legend items.
- 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.
- grouptitlefont
Sets the font for group titles in legend. Defaults to
legend.fontwith its size increased about 10%.- indentation
Sets the indentation (in px) of the legend entries.
- 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.
- 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.
- itemsizing
Determines if the legend items symbols scale with their corresponding “trace” attributes or remain “constant” independent of the symbol size on the graph.
- itemwidth
Sets the width (in px) of the legend item symbols (the part other than the title.text).
- orientation
Sets the orientation of the legend.
- title
plotly.graph_objects.layout.legend.Titl einstance or dict with compatible properties- tracegroupgap
Sets the amount of vertical space (in px) between legend groups.
- 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
legendgroupis provided). if “grouped+reversed”, the items are displayed in the opposite order as “grouped”.- uirevision
Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to
layout.uirevision.- valign
Sets the vertical alignment of the symbols with respect to their associated text.
- visible
Determines whether or not this legend is visible.
- x
Sets the x position with respect to
xref(in normalized coordinates) of the legend. Whenxrefis “paper”, defaults to 1.02 for vertical legends and defaults to 0 for horizontal legends. Whenxrefis “container”, defaults to 1 for vertical legends and defaults to 0 for horizontal legends. Must be between 0 and 1 ifxrefis “container”. and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets the legend’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the legend. Value “auto” anchors legends to the right forxvalues greater than or equal to 2/3, anchors legends to the left forxvalues less than or equal to 1/3 and anchors legends with respect to their center otherwise.- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yref(in normalized coordinates) of the legend. Whenyrefis “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. Whenyrefis “container”, defaults to 1. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets the legend’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the legend. Value “auto” anchors legends at their bottom foryvalues less than or equal to 1/3, anchors legends to at their top foryvalues greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
map¶The ‘map’ property is an instance of Map that may be specified as:
An instance of
plotly.graph_objects.layout.MapA dict of string/value properties that will be passed to the Map constructor
Supported dict properties:
- bearing
Sets the bearing angle of the map in degrees counter-clockwise from North (map.bearing).
- bounds
plotly.graph_objects.layout.map.Boundsinstance or dict with compatible properties- center
plotly.graph_objects.layout.map.Centerinstance or dict with compatible properties- domain
plotly.graph_objects.layout.map.Domaininstance or dict with compatible properties- layers
A tuple of
plotly.graph_objects.layout.map.Layerinstances or dicts with compatible properties- 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
- pitch
Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (map.pitch).
- 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 inlayout.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.- uirevision
Controls persistence of user-driven changes in the view:
center,zoom,bearing,pitch. Defaults tolayout.uirevision.- zoom
Sets the zoom level of the map (map.zoom).
mapbox¶The ‘mapbox’ property is an instance of Mapbox that may be specified as:
An instance of
plotly.graph_objects.layout.MapboxA dict of string/value properties that will be passed to the Mapbox constructor
Supported dict properties:
- 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 whenstyle(e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.- bearing
Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).
- bounds
plotly.graph_objects.layout.mapbox.Boun dsinstance or dict with compatible properties- center
plotly.graph_objects.layout.mapbox.Cent erinstance or dict with compatible properties- domain
plotly.graph_objects.layout.mapbox.Doma ininstance or dict with compatible properties- layers
A tuple of
plotly.graph_objects.layout. mapbox.Layerinstances or dicts with compatible properties- 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
- pitch
Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).
- 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 inlayout.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 theaccesstokenattribute or in themapboxAccessTokenconfig 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>- uirevision
Controls persistence of user-driven changes in the view:
center,zoom,bearing,pitch. Defaults tolayout.uirevision.- zoom
Sets the zoom level of the map (mapbox.zoom).
margin¶The ‘margin’ property is an instance of Margin that may be specified as:
An instance of
plotly.graph_objects.layout.MarginA dict of string/value properties that will be passed to the Margin constructor
Supported dict properties:
- autoexpand
Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults.
- b
Sets the bottom margin (in px).
- l
Sets the left margin (in px).
- pad
Sets the amount of padding (in px) between the plotting area and the axis lines
- r
Sets the right margin (in px).
- t
Sets the top margin (in px).
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]}.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
minreducedheight¶Minimum height of the plot with margin.automargin applied (in px)
An int or float in the interval [2, inf]
int|float
minreducedwidth¶Minimum width of the plot with margin.automargin applied (in px)
An int or float in the interval [2, inf]
int|float
modebar¶The ‘modebar’ property is an instance of Modebar that may be specified as:
An instance of
plotly.graph_objects.layout.ModebarA dict of string/value properties that will be passed to the Modebar constructor
Supported dict properties:
- activecolor
Sets the color of the active or hovered on icons in the modebar.
- 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.modeBarButtonsToAddoption. This may include “v1hovermode”, “hoverclosest”, “hovercompare”, “togglehover”, “togglespikelines”, “drawline”, “drawopenpath”, “drawclosedpath”, “drawcircle”, “drawrect”, “eraseshape”.- addsrc
Sets the source reference on Chart Studio Cloud for
add.- bgcolor
Sets the background color of the modebar.
- color
Sets the color of the icons in the modebar.
- orientation
Sets the orientation of the modebar.
- remove
Determines which predefined modebar buttons to remove. Similar to
config.modeBarButtonsToRemoveoption. 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”.- removesrc
Sets the source reference on Chart Studio Cloud for
remove.- uirevision
Controls persistence of user-driven changes related to the modebar, including
hovermode,dragmode, andshowspikesat both the root level and inside subplots. Defaults tolayout.uirevision.
newselection¶The ‘newselection’ property is an instance of Newselection that may be specified as:
An instance of
plotly.graph_objects.layout.NewselectionA dict of string/value properties that will be passed to the Newselection constructor
Supported dict properties:
- line
plotly.graph_objects.layout.newselectio n.Lineinstance or dict with compatible properties- mode
Describes how a new selection is created. If
immediate, a new selection is created after first mouse up. Ifgradual, 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.
newshape¶The ‘newshape’ property is an instance of Newshape that may be specified as:
An instance of
plotly.graph_objects.layout.NewshapeA dict of string/value properties that will be passed to the Newshape constructor
Supported dict properties:
- drawdirection
When
dragmodeis 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.- 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.
- fillrule
Determines the path’s interior. For more info please visit https://developer.mozilla.org/en- US/docs/Web/SVG/Attribute/fill-rule
- label
plotly.graph_objects.layout.newshape.La belinstance or dict with compatible properties- layer
Specifies whether new shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).
- 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.- 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.
- legendgrouptitle
plotly.graph_objects.layout.newshape.Le gendgrouptitleinstance or dict with compatible properties- legendrank
Sets the legend rank for new shape. Items and groups with smaller ranks are presented on top/left side while with “reversed”
legend.traceorderthey 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.- legendwidth
Sets the width (in px or fraction) of the legend for new shape.
- line
plotly.graph_objects.layout.newshape.Li neinstance or dict with compatible properties- name
Sets new shape name. The name appears as the legend item.
- opacity
Sets the opacity of new shapes.
- showlegend
Determines whether or not new shape is shown in the legend.
- 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).
paper_bgcolor¶Sets the background color of the paper where the graph is drawn.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
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.
The ‘piecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
plot_bgcolor¶Sets the background color of the plotting area in-between x and y 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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
polar¶The ‘polar’ property is an instance of Polar that may be specified as:
An instance of
plotly.graph_objects.layout.PolarA dict of string/value properties that will be passed to the Polar constructor
Supported dict properties:
- angularaxis
plotly.graph_objects.layout.polar.Angul arAxisinstance or dict with compatible properties- 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.
- 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.
- bgcolor
Set the background color of the subplot
- domain
plotly.graph_objects.layout.polar.Domai ninstance or dict with compatible properties- 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 thatradialaxis.angleis snapped to the angle of the closest vertex whengridshapeis “circular” (so that radial axis scale is the same as the data scale).- hole
Sets the fraction of the radius to cut out of the polar subplot.
- radialaxis
plotly.graph_objects.layout.polar.Radia lAxisinstance or dict with compatible properties- sector
Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with 0 corresponding to rightmost limit of the polar subplot.
- uirevision
Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to
layout.uirevision.
re = <module 're' from '/home/circleci/.pyenv/versions/3.9.22/lib/python3.9/re.py'>¶scattergap¶Sets the gap (in plot fraction) between scatter points of
adjacent location coordinates. Defaults to bargap.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
scene¶The ‘scene’ property is an instance of Scene that may be specified as:
An instance of
plotly.graph_objects.layout.SceneA dict of string/value properties that will be passed to the Scene constructor
Supported dict properties:
- annotations
A tuple of
plotly.graph_objects.layout. scene.Annotationinstances or dicts with compatible properties- annotationdefaults
When used in a template (as layout.template.lay out.scene.annotationdefaults), sets the default property values to use for elements of layout.scene.annotations
- 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.
- aspectratio
Sets this scene’s axis aspectratio.
bgcolor
- camera
plotly.graph_objects.layout.scene.Camer ainstance or dict with compatible properties- domain
plotly.graph_objects.layout.scene.Domai ninstance or dict with compatible properties- dragmode
Determines the mode of drag interactions for this scene.
- hovermode
Determines the mode of hover interactions for this scene.
- uirevision
Controls persistence of user-driven changes in camera attributes. Defaults to
layout.uirevision.- xaxis
:class:`plotly.graph_objects.layout.scene.XAxis ` instance or dict with compatible properties
- yaxis
:class:`plotly.graph_objects.layout.scene.YAxis ` instance or dict with compatible properties
- zaxis
:class:`plotly.graph_objects.layout.scene.ZAxis ` 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.
[‘h’, ‘v’, ‘d’, ‘any’]
Any
selectiondefaults¶When used in a template (as layout.template.layout.selectiondefaults), sets the default property values to use for elements of layout.selections
The ‘selectiondefaults’ property is an instance of Selection that may be specified as:
An instance of
plotly.graph_objects.layout.SelectionA dict of string/value properties that will be passed to the Selection constructor
Supported dict properties:
selectionrevision¶Controls persistence of user-driven changes in selected points from all traces.
The ‘selectionrevision’ property accepts values of any type
Any
selections¶The ‘selections’ property is a tuple of instances of Selection that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Selection
A list or tuple of dicts of string/value properties that will be passed to the Selection constructor
Supported dict properties:
- line
plotly.graph_objects.layout.selection.L ineinstance or dict with compatible properties- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- opacity
Sets the opacity of the selection.
- path
For
type“path” - a valid SVG path similar toshapes.pathin data coordinates. Allowed segments are: M, L and Z.- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- 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 usingpath.- x0
Sets the selection’s starting x position.
- x1
Sets the selection’s end x position.
- xref
Sets the selection’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the
xposition refers to a x coordinate. If set to “paper”, thexposition 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.- y0
Sets the selection’s starting y position.
- y1
Sets the selection’s end y position.
- yref
Sets the selection’s x coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the
yposition refers to a y coordinate. If set to “paper”, theyposition 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.
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.
A string
A number that will be converted to a string
shapedefaults¶When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes
The ‘shapedefaults’ property is an instance of Shape that may be specified as:
An instance of
plotly.graph_objects.layout.ShapeA dict of string/value properties that will be passed to the Shape constructor
Supported dict properties:
shapes¶The ‘shapes’ property is a tuple of instances of Shape that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Shape
A list or tuple of dicts of string/value properties that will be passed to the Shape constructor
Supported dict properties:
- 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.editableorconfig.edits.shapePosition.- fillcolor
Sets the color filling the shape’s interior. Only applies to closed shapes.
- 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
- label
:class:`plotly.graph_objects.layout.shape.Label ` instance or dict with compatible properties
- layer
Specifies whether shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).
- 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.- 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.
- legendgrouptitle
plotly.graph_objects.layout.shape.Legen dgrouptitleinstance or dict with compatible properties- legendrank
Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with “reversed”
legend.traceorderthey 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.- legendwidth
Sets the width (in px or fraction) of the legend for this shape.
- line
plotly.graph_objects.layout.shape.Lineinstance or dict with compatible properties- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- opacity
Sets the opacity of the shape.
- path
For
type“path” - a valid SVG path with the pixel values replaced by data values inxsizemode/ysizemodebeing “scaled” and taken unmodified as pixels relative toxanchorandyanchorin 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- showlegend
Determines whether or not this shape is shown in the legend.
- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- 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 usingpath. with respect to the axes’ sizing mode.- 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).
- x0
Sets the shape’s starting x position. See
typeandxsizemodefor more info.- x0shift
Shifts
x0away from the center of the category whenxrefis a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.- x1
Sets the shape’s end x position. See
typeandxsizemodefor more info.- x1shift
Shifts
x1away from the center of the category whenxrefis a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.- xanchor
Only relevant in conjunction with
xsizemodeset to “pixel”. Specifies the anchor point on the x axis to whichx0,x1and x coordinates withinpathare relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect whenxsizemodenot set to “pixel”.- xref
Sets the shape’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the
xposition refers to a x coordinate. If set to “paper”, thexposition 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.- xsizemode
Sets the shapes’s sizing mode along the x axis. If set to “scaled”,
x0,x1and x coordinates withinpathrefer to data values on the x axis or a fraction of the plot area’s width (xrefset to “paper”). If set to “pixel”,xanchorspecifies the x position in terms of data or plot fraction butx0,x1and x coordinates withinpathare pixels relative toxanchor. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.- y0
Sets the shape’s starting y position. See
typeandysizemodefor more info.- y0shift
Shifts
y0away from the center of the category whenyrefis a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.- y1
Sets the shape’s end y position. See
typeandysizemodefor more info.- y1shift
Shifts
y1away from the center of the category whenyrefis a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.- yanchor
Only relevant in conjunction with
ysizemodeset to “pixel”. Specifies the anchor point on the y axis to whichy0,y1and y coordinates withinpathare relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect whenysizemodenot set to “pixel”.- yref
Sets the shape’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the
yposition refers to a y coordinate. If set to “paper”, theyposition 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.- ysizemode
Sets the shapes’s sizing mode along the y axis. If set to “scaled”,
y0,y1and y coordinates withinpathrefer to data values on the y axis or a fraction of the plot area’s height (yrefset to “paper”). If set to “pixel”,yanchorspecifies the y position in terms of data or plot fraction buty0,y1and y coordinates withinpathare pixels relative toyanchor. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.
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.
The ‘showlegend’ property must be specified as a bool (either True, or False)
sliderdefaults¶When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders
The ‘sliderdefaults’ property is an instance of Slider that may be specified as:
An instance of
plotly.graph_objects.layout.SliderA dict of string/value properties that will be passed to the Slider constructor
Supported dict properties:
sliders¶The ‘sliders’ property is a tuple of instances of Slider that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Slider
A list or tuple of dicts of string/value properties that will be passed to the Slider constructor
Supported dict properties:
- active
Determines which button (by index starting from 0) is considered active.
- activebgcolor
Sets the background color of the slider grip while dragging.
- bgcolor
Sets the background color of the slider.
- bordercolor
Sets the color of the border enclosing the slider.
- borderwidth
Sets the width (in px) of the border enclosing the slider.
- currentvalue
plotly.graph_objects.layout.slider.Curr entvalueinstance or dict with compatible properties- font
Sets the font of the slider step labels.
- 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.
- lenmode
Determines whether this slider length is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minorticklen
Sets the length in pixels of minor step tick marks
- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- pad
Set the padding of the slider component along each side.
- steps
A tuple of
plotly.graph_objects.layout. slider.Stepinstances or dicts with compatible properties- 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
- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- tickcolor
Sets the color of the border enclosing the slider.
- ticklen
Sets the length in pixels of step tick marks
- tickwidth
Sets the tick width (in px).
- transition
plotly.graph_objects.layout.slider.Tran sitioninstance or dict with compatible properties- visible
Determines whether or not the slider is visible.
- x
Sets the x position (in normalized coordinates) of the slider.
- xanchor
Sets the slider’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the range selector.- y
Sets the y position (in normalized coordinates) of the slider.
- yanchor
Sets the slider’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the range selector.
smith¶The ‘smith’ property is an instance of Smith that may be specified as:
An instance of
plotly.graph_objects.layout.SmithA dict of string/value properties that will be passed to the Smith constructor
Supported dict properties:
- bgcolor
Set the background color of the subplot
- domain
plotly.graph_objects.layout.smith.Domai ninstance or dict with compatible properties- imaginaryaxis
plotly.graph_objects.layout.smith.Imagi naryaxisinstance or dict with compatible properties- realaxis
plotly.graph_objects.layout.smith.Reala xisinstance 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.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
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.
The ‘sunburstcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
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.
The ‘template’ property is an instance of Template that may be specified as:
An instance of
plotly.graph_objects.layout.TemplateA dict of string/value properties that will be passed to the Template constructor
Supported dict properties:
- data
plotly.graph_objects.layout.template.Da tainstance or dict with compatible properties- layout
plotly.graph_objects.Layoutinstance or dict with compatible propertiesThe name of a registered template where current registered templates are stored in the plotly.io.templates configuration object. The names of all registered templates can be retrieved with:
>>> import plotly.io as pio >>> list(pio.templates) ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]A string containing multiple registered template names, joined on ‘+’ characters (e.g. ‘template1+template2’). In this case the resulting template is computed by merging together the collection of registered templates
ternary¶The ‘ternary’ property is an instance of Ternary that may be specified as:
An instance of
plotly.graph_objects.layout.TernaryA dict of string/value properties that will be passed to the Ternary constructor
Supported dict properties:
- aaxis
plotly.graph_objects.layout.ternary.Aax isinstance or dict with compatible properties- baxis
plotly.graph_objects.layout.ternary.Bax isinstance or dict with compatible properties- bgcolor
Set the background color of the subplot
- caxis
plotly.graph_objects.layout.ternary.Cax isinstance or dict with compatible properties- domain
plotly.graph_objects.layout.ternary.Dom aininstance or dict with compatible properties- sum
The number each triplet should sum to, and the maximum range of each axis
- uirevision
Controls persistence of user-driven changes in axis
minandtitle, if not overridden in the individual axes. Defaults tolayout.uirevision.
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.layout.TitleA dict of string/value properties that will be passed to the Title constructor
Supported dict properties:
- 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. Ifyref='container'then the margins will ensure that the title doesn’t overlap with the plot area, tick labels, and axis titles. Ifautomargin=trueand 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 whenyref='paper', only 1 or 0 are allowed y values. Invalid values will be reset to the default 1.- font
Sets the title font.
- pad
Sets the padding of the title. Each padding value only applies when the corresponding
xanchor/yanchorvalue is set accordingly. E.g. for left padding to take effect,xanchormust be set to “left”. The same rule applies ifxanchor/yanchoris determined automatically. Padding is muted if the respective anchor value is “middle*/*center”.- subtitle
plotly.graph_objects.layout.title.Subti tleinstance or dict with compatible properties- text
Sets the plot’s title.
- x
Sets the x position with respect to
xrefin normalized coordinates from 0 (left) to 1 (right).- 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
xrefby three and calculates thexanchorvalue automatically based on the value ofx.- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefin normalized coordinates from 0 (bottom) to 1 (top). “auto” places the baseline of the title onto the vertical center of the top margin.- 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
yrefby three and calculates theyanchorvalue automatically based on the value ofy.- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
transition¶Sets transition options used during Plotly.react updates.
The ‘transition’ property is an instance of Transition that may be specified as:
An instance of
plotly.graph_objects.layout.TransitionA dict of string/value properties that will be passed to the Transition constructor
Supported dict properties:
- duration
The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.
- easing
The easing function used for the transition
- ordering
Determines whether the figure’s layout or traces smoothly transitions during updates that make both traces and layout change.
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.
The ‘treemapcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
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.
The ‘uirevision’ property accepts values of any type
Any
uniformtext¶The ‘uniformtext’ property is an instance of Uniformtext that may be specified as:
An instance of
plotly.graph_objects.layout.UniformtextA dict of string/value properties that will be passed to the Uniformtext constructor
Supported dict properties:
- minsize
Sets the minimum text size between traces of the same type.
- 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.minsizeusing “hide” option hides the text; and using “show” option shows the text without further downscaling. Please note that if the size defined byminsizeis greater than the font size defined by trace, then theminsizeis used.
When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus
The ‘updatemenudefaults’ property is an instance of Updatemenu that may be specified as:
An instance of
plotly.graph_objects.layout.UpdatemenuA dict of string/value properties that will be passed to the Updatemenu constructor
Supported dict properties:
The ‘updatemenus’ property is a tuple of instances of Updatemenu that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Updatemenu
A list or tuple of dicts of string/value properties that will be passed to the Updatemenu constructor
Supported dict properties:
- active
Determines which button (by index starting from 0) is considered active.
- bgcolor
Sets the background color of the update menu buttons.
- bordercolor
Sets the color of the border enclosing the update menu.
- borderwidth
Sets the width (in px) of the border enclosing the update menu.
- buttons
A tuple of
plotly.graph_objects.layout. updatemenu.Buttoninstances or dicts with compatible properties- buttondefaults
When used in a template (as layout.template.lay out.updatemenu.buttondefaults), sets the default property values to use for elements of layout.updatemenu.buttons
- direction
Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For
leftandup, the buttons will still appear in left-to-right or top-to-bottom order respectively.- font
Sets the font of the update menu button text.
- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- pad
Sets the padding around the buttons or dropdown menu.
- showactive
Highlights active dropdown item or active button if true.
- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- type
Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically
- visible
Determines whether or not the update menu is visible.
- x
Sets the x position (in normalized coordinates) of the update menu.
- xanchor
Sets the update menu’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the range selector.- y
Sets the y position (in normalized coordinates) of the update menu.
- yanchor
Sets the update menu’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the range selector.
violingap¶Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
violingroupgap¶Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
waterfallgap¶Sets the gap (in plot fraction) between bars of adjacent location coordinates.
An int or float in the interval [0, 1]
int|float
waterfallgroupgap¶Sets the gap (in plot fraction) between bars of the same location coordinate.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
width¶Sets the plot’s width (in px).
An int or float in the interval [10, inf]
int|float
xaxis¶The ‘xaxis’ property is an instance of XAxis that may be specified as:
An instance of
plotly.graph_objects.layout.XAxisA dict of string/value properties that will be passed to the XAxis constructor
Supported dict properties:
- 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 byposition.- automargin
Determines whether long tick labels automatically grow the figure margins.
- autorange
Determines whether or not the range of this axis is computed in relation to the input data. See
rangemodefor more info. Ifrangeis provided and it has a value for both the lower and upper bound,autorangeis 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.- autorangeoptions
plotly.graph_objects.layout.xaxis.Autor angeoptionsinstance or dict with compatible properties- autotickangles
When
tickangleis set to “auto”, it will be set to the first angle in this array that is large enough to prevent label overlap.- 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
typedetection. Defaults to layout.autotypenumbers.- calendar
Sets the calendar system to use for
rangeandtick0if 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 globallayout.calendar- categoryarray
Sets the order in which categories on this axis appear. Only has an effect if
categoryorderis set to “array”. Used withcategoryorder.- categoryarraysrc
Sets the source reference on Chart Studio Cloud for
categoryarray.- 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
categoryorderto category ascending or category descending if order should be determined by the alphanumerical order of the category names. Setcategoryorderto “array” to derive the ordering from the attributecategoryarray. If a category is not found in thecategoryarrayarray, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories incategoryarray. Setcategoryorderto 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.- 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.
- constrain
If this axis needs to be compressed (either due to its own
scaleanchorandscaleratioor 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.- constraintoward
If this axis needs to be compressed (either due to its own
scaleanchorandscaleratioor 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.- dividercolor
Sets the color of the dividers Only has an effect on “multicategory” axes.
- dividerwidth
Sets the width (in px) of the dividers Only has an effect on “multicategory” axes.
- domain
Sets the domain of this axis (in plot fraction).
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- fixedrange
Determines whether or not this axis is zoom- able. If true, then zoom is disabled.
- gridcolor
Sets the color of the grid lines.
- griddash
Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
- gridwidth
Sets the width (in px) of the grid lines.
- hoverformat
Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- insiderange
Could be used to set the desired inside range of this axis (excluding the labels) when
ticklabelpositionof the anchored axis has “inside”. Not implemented for axes withtype“log”. This would be ignored whenrangeis provided.- 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.
- 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
cliponaxisset to False to show markers and/or text nodes above this axis.- linecolor
Sets the axis line color.
- linewidth
Sets the width (in px) of the axis line.
- 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 ascaleanchorand amatchesconstraint is currently forbidden. Moreover, note that matching axes must have the sametype.- maxallowed
Determines the maximum range of this axis.
- minallowed
Determines the minimum range of this axis.
- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- minor
:class:`plotly.graph_objects.layout.xaxis.Minor ` instance or dict with compatible properties
- 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.
- 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 iftickmodeis set to “auto”.- 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.
- position
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if
anchoris set to “free”.- range
Sets the range of this axis. If the axis
typeis “log”, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axistypeis “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistypeis “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 elementsnullimpacts the defaultautorange.- rangebreaks
A tuple of
plotly.graph_objects.layout. xaxis.Rangebreakinstances or dicts with compatible properties- rangebreakdefaults
When used in a template (as layout.template.lay out.xaxis.rangebreakdefaults), sets the default property values to use for elements of layout.xaxis.rangebreaks
- 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.
- rangeselector
plotly.graph_objects.layout.xaxis.Range selectorinstance or dict with compatible properties- rangeslider
plotly.graph_objects.layout.xaxis.Range sliderinstance or dict with compatible properties- 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.constrainandconstraintowarddetermine how we enforce the constraint. You can chain these, ieyaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}but you can only link axes of the sametype. 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 viascaleratio. Note that setting axes simultaneously in both ascaleanchorand amatchesconstraint is currently forbidden. Settingfalseallows to remove a default constraint (occasionally, you may need to prevent a defaultscaleanchorconstraint from being applied, eg. when having an image traceyaxis: {scaleanchor: "x"}is set automatically in order for pixels to be rendered as squares, settingyaxis: {scaleanchor: false}allows to remove the constraint).- 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.- separatethousands
If “true”, even 4-digit integers are separated
- showdividers
Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on “multicategory” axes.
- 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.
- showgrid
Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.
- showline
Determines whether or not a line bounding this axis is drawn.
- showspikes
Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- side
Determines whether a x (y) axis is positioned at the “bottom” (“left”) or “top” (“right”) of the plotting area.
- spikecolor
Sets the spike color. If undefined, will use the series color
- 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”).
- 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
- spikesnap
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
- spikethickness
Sets the width (in px) of the zero line.
- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the tick font.
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.layout. xaxis.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.lay out.xaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.xaxis.tickformatstops
- 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, chooseticklabelindex-1. This is useful for date axes withticklabelmode“period” if you want to label the period that ends with each major tick instead of the period that begins there.- ticklabelindexsrc
Sets the source reference on Chart Studio Cloud for
ticklabelindex.- 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.- 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.
- 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
ticklabelmodeis set to “period”. Similarly left or right has no effect on y axes or whenticklabelmodeis set to “period”. Has no effect on “multicategory” axes or whenticksonis set to “boundaries”. When used on axes linked bymatchesorscaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.- 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.
- ticklabelstandoff
Sets the standoff distance (in px) between the axis tick labels and their default position. A positive
ticklabelstandoffmoves the labels farther away from the plot area ifticklabelpositionis “outside”, and deeper into the plot area ifticklabelpositionis “inside”. A negativeticklabelstandoffworks 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.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided). If “sync”, the number of ticks will sync with the overlayed axis set byoverlayingproperty.- tickprefix
Sets a tick label prefix.
- 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.
- 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.- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
:class:`plotly.graph_objects.layout.xaxis.Title ` instance or dict with compatible properties
- 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.
- uirevision
Controls persistence of user-driven changes in axis
range,autorange, andtitleif ineditable: trueconfiguration. Defaults tolayout.uirevision.- 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
- 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.
- zerolinecolor
Sets the line color of the zero line.
- zerolinewidth
Sets the width (in px) of the zero line.
yaxis¶The ‘yaxis’ property is an instance of YAxis that may be specified as:
An instance of
plotly.graph_objects.layout.YAxisA dict of string/value properties that will be passed to the YAxis constructor
Supported dict properties:
- 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 byposition.- automargin
Determines whether long tick labels automatically grow the figure margins.
- autorange
Determines whether or not the range of this axis is computed in relation to the input data. See
rangemodefor more info. Ifrangeis provided and it has a value for both the lower and upper bound,autorangeis 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.- autorangeoptions
plotly.graph_objects.layout.yaxis.Autor angeoptionsinstance or dict with compatible properties- autoshift
Automatically reposition the axis to avoid overlap with other axes with the same
overlayingvalue. This repositioning will account for anyshiftamount applied to other axes on the same side withautoshiftis set to true. Only has an effect ifanchoris set to “free”.- autotickangles
When
tickangleis set to “auto”, it will be set to the first angle in this array that is large enough to prevent label overlap.- 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
typedetection. Defaults to layout.autotypenumbers.- calendar
Sets the calendar system to use for
rangeandtick0if 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 globallayout.calendar- categoryarray
Sets the order in which categories on this axis appear. Only has an effect if
categoryorderis set to “array”. Used withcategoryorder.- categoryarraysrc
Sets the source reference on Chart Studio Cloud for
categoryarray.- 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
categoryorderto category ascending or category descending if order should be determined by the alphanumerical order of the category names. Setcategoryorderto “array” to derive the ordering from the attributecategoryarray. If a category is not found in thecategoryarrayarray, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories incategoryarray. Setcategoryorderto 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.- 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.
- constrain
If this axis needs to be compressed (either due to its own
scaleanchorandscaleratioor 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.- constraintoward
If this axis needs to be compressed (either due to its own
scaleanchorandscaleratioor 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.- dividercolor
Sets the color of the dividers Only has an effect on “multicategory” axes.
- dividerwidth
Sets the width (in px) of the dividers Only has an effect on “multicategory” axes.
- domain
Sets the domain of this axis (in plot fraction).
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- fixedrange
Determines whether or not this axis is zoom- able. If true, then zoom is disabled.
- gridcolor
Sets the color of the grid lines.
- griddash
Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
- gridwidth
Sets the width (in px) of the grid lines.
- hoverformat
Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- insiderange
Could be used to set the desired inside range of this axis (excluding the labels) when
ticklabelpositionof the anchored axis has “inside”. Not implemented for axes withtype“log”. This would be ignored whenrangeis provided.- 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.
- 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
cliponaxisset to False to show markers and/or text nodes above this axis.- linecolor
Sets the axis line color.
- linewidth
Sets the width (in px) of the axis line.
- 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 ascaleanchorand amatchesconstraint is currently forbidden. Moreover, note that matching axes must have the sametype.- maxallowed
Determines the maximum range of this axis.
- minallowed
Determines the minimum range of this axis.
- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- minor
:class:`plotly.graph_objects.layout.yaxis.Minor ` instance or dict with compatible properties
- 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.
- 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 iftickmodeis set to “auto”.- 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.
- position
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if
anchoris set to “free”.- range
Sets the range of this axis. If the axis
typeis “log”, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axistypeis “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistypeis “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 elementsnullimpacts the defaultautorange.- rangebreaks
A tuple of
plotly.graph_objects.layout. yaxis.Rangebreakinstances or dicts with compatible properties- rangebreakdefaults
When used in a template (as layout.template.lay out.yaxis.rangebreakdefaults), sets the default property values to use for elements of layout.yaxis.rangebreaks
- 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.
- 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.constrainandconstraintowarddetermine how we enforce the constraint. You can chain these, ieyaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}but you can only link axes of the sametype. 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 viascaleratio. Note that setting axes simultaneously in both ascaleanchorand amatchesconstraint is currently forbidden. Settingfalseallows to remove a default constraint (occasionally, you may need to prevent a defaultscaleanchorconstraint from being applied, eg. when having an image traceyaxis: {scaleanchor: "x"}is set automatically in order for pixels to be rendered as squares, settingyaxis: {scaleanchor: false}allows to remove the constraint).- 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.- separatethousands
If “true”, even 4-digit integers are separated
- 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
autoshiftis set to true, then this defaults to a padding of -3 ifsideis set to “left”. and defaults to +3 ifsideis set to “right”. Defaults to 0 ifautoshiftis set to false. Only has an effect ifanchoris set to “free”.- showdividers
Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on “multicategory” axes.
- 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.
- showgrid
Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.
- showline
Determines whether or not a line bounding this axis is drawn.
- showspikes
Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- side
Determines whether a x (y) axis is positioned at the “bottom” (“left”) or “top” (“right”) of the plotting area.
- spikecolor
Sets the spike color. If undefined, will use the series color
- 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”).
- 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
- spikesnap
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
- spikethickness
Sets the width (in px) of the zero line.
- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the tick font.
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.layout. yaxis.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.lay out.yaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.yaxis.tickformatstops
- 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, chooseticklabelindex-1. This is useful for date axes withticklabelmode“period” if you want to label the period that ends with each major tick instead of the period that begins there.- ticklabelindexsrc
Sets the source reference on Chart Studio Cloud for
ticklabelindex.- 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.- 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.
- 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
ticklabelmodeis set to “period”. Similarly left or right has no effect on y axes or whenticklabelmodeis set to “period”. Has no effect on “multicategory” axes or whenticksonis set to “boundaries”. When used on axes linked bymatchesorscaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.- 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.
- ticklabelstandoff
Sets the standoff distance (in px) between the axis tick labels and their default position. A positive
ticklabelstandoffmoves the labels farther away from the plot area ifticklabelpositionis “outside”, and deeper into the plot area ifticklabelpositionis “inside”. A negativeticklabelstandoffworks 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.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided). If “sync”, the number of ticks will sync with the overlayed axis set byoverlayingproperty.- tickprefix
Sets a tick label prefix.
- 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.
- 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.- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
:class:`plotly.graph_objects.layout.yaxis.Title ` instance or dict with compatible properties
- 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.
- uirevision
Controls persistence of user-driven changes in axis
range,autorange, andtitleif ineditable: trueconfiguration. Defaults tolayout.uirevision.- 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
- 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.
- zerolinecolor
Sets the line color of the zero line.
- zerolinewidth
Sets the width (in px) of the zero line.
plotly.graph_objects.Legend(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Legend is deprecated.
plotly.graph_objects.layout.Legend
plotly.graph_objects.Line(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Line is deprecated.
plotly.graph_objects.scatter.Line
plotly.graph_objects.layout.shape.Line
etc.
plotly.graph_objects.Margin(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Margin is deprecated.
plotly.graph_objects.layout.Margin
plotly.graph_objects.Marker(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Marker is deprecated.
plotly.graph_objects.scatter.Marker
plotly.graph_objects.histogram.selected.Marker
etc.
plotly.graph_objects.Mesh3d(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alphahull¶Determines how the mesh surface triangles are derived from the
set of vertices (points) represented by the x, y and z
arrays, if the i, j, k arrays are not supplied. For
general use of mesh3d it is preferred that i, j, k are
supplied. If “-1”, Delaunay triangulation is used, which is
mainly suitable if the mesh is a single, more or less layer
surface that is perpendicular to delaunayaxis. In case the
delaunayaxis intersects the mesh surface at more than one
point it will result triangles that are very long in the
dimension of delaunayaxis. If “>0”, the alpha-shape algorithm
is used. In this case, the positive alphahull value signals
the use of the alpha-shape algorithm, _and_ its value acts as
the parameter for the mesh fitting. If 0, the convex-hull
algorithm is used. It is suitable for convex bodies or if the
intention is to enclose the x, y and z point set into a
convex hull.
An int or float
int|float
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 intensity) 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 intensity 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 intensity. 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 intensity and if set, cmax must be set as
well.
An int or float
int|float
color¶Sets the color of the whole mesh
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to mesh3d.colorscale
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.mesh3d.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.mesh3d. colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.mesh3d.colorbar.tickformatstopdefaults), sets the default property values to use for elements of mesh3d.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.mesh3d.colorbar.Ti tleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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.
contour¶The ‘contour’ property is an instance of Contour that may be specified as:
An instance of
plotly.graph_objects.mesh3d.ContourA dict of string/value properties that will be passed to the Contour constructor
Supported dict properties:
- color
Sets the color of the contour lines.
- show
Sets whether or not dynamic contours are shown on hover
- width
Sets the width of the contour lines.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
delaunayaxis¶Sets the Delaunay axis, which is the axis that is perpendicular
to the surface of the Delaunay triangulation. It has an effect
if i, j, k are not provided and alphahull is set to
indicate Delaunay triangulation.
[‘x’, ‘y’, ‘z’]
Any
facecolor¶Sets the color of each face Overrides “color” and “vertexcolor”.
The ‘facecolor’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
facecolorsrc¶Sets the source reference on Chart Studio Cloud for
facecolor.
The ‘facecolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
flatshading¶Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
The ‘flatshading’ property must be specified as a bool (either True, or False)
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.mesh3d.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
i¶A vector of vertex indices, i.e. integer values between 0 and
the length of the vertex vectors, representing the “first”
vertex of a triangle. For example, {i[m], j[m], k[m]}
together represent face m (triangle m) in the mesh, where i[m]
= n points to the triplet {x[n], y[n], z[n]} in the vertex
arrays. Therefore, each element in i represents a point in
space, which is the first vertex of a triangle.
The ‘i’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
intensity¶Sets the intensity values for vertices or cells as defined by
intensitymode. It can be used for plotting fields on meshes.
The ‘intensity’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
intensitymode¶Determines the source of intensity values.
[‘vertex’, ‘cell’]
Any
intensitysrc¶Sets the source reference on Chart Studio Cloud for
intensity.
The ‘intensitysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
isrc¶Sets the source reference on Chart Studio Cloud for i.
The ‘isrc’ property must be specified as a string or as a plotly.grid_objs.Column object
j¶A vector of vertex indices, i.e. integer values between 0 and
the length of the vertex vectors, representing the “second”
vertex of a triangle. For example, {i[m], j[m], k[m]}
together represent face m (triangle m) in the mesh, where j[m]
= n points to the triplet {x[n], y[n], z[n]} in the vertex
arrays. Therefore, each element in j represents a point in
space, which is the second vertex of a triangle.
The ‘j’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
jsrc¶Sets the source reference on Chart Studio Cloud for j.
The ‘jsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
k¶A vector of vertex indices, i.e. integer values between 0 and
the length of the vertex vectors, representing the “third”
vertex of a triangle. For example, {i[m], j[m], k[m]}
together represent face m (triangle m) in the mesh, where k[m]
= n points to the triplet {x[n], y[n], z[n]} in the vertex
arrays. Therefore, each element in k represents a point in
space, which is the third vertex of a triangle.
The ‘k’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
ksrc¶Sets the source reference on Chart Studio Cloud for k.
The ‘ksrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.mesh3d.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lighting¶The ‘lighting’ property is an instance of Lighting that may be specified as:
An instance of
plotly.graph_objects.mesh3d.LightingA dict of string/value properties that will be passed to the Lighting constructor
Supported dict properties:
- ambient
Ambient light increases overall color visibility but can wash out the image.
- diffuse
Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
lightposition¶The ‘lightposition’ property is an instance of Lightposition that may be specified as:
An instance of
plotly.graph_objects.mesh3d.LightpositionA dict of string/value properties that will be passed to the Lightposition constructor
Supported dict properties:
- x
Numeric vector, representing the X coordinate for each vertex.
- y
Numeric vector, representing the Y coordinate for each vertex.
- z
Numeric vector, representing the Z coordinate for each vertex.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the surface. Please note that in the case
of using high opacity values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the webgl API. This behavior may be
improved in the near future and is subject to change.
An int or float in the interval [0, 1]
int|float
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)
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.mesh3d.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with the vertices. If trace
hoverinfo contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
vertexcolor¶Sets the color of each vertex Overrides “color”. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.
The ‘vertexcolor’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
vertexcolorsrc¶Sets the source reference on Chart Studio Cloud for
vertexcolor.
The ‘vertexcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the X coordinates of the vertices. The nth element of
vectors x, y and z jointly represent the X, Y and Z
coordinates of the nth vertex.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the Y coordinates of the vertices. The nth element of
vectors x, y and z jointly represent the X, Y and Z
coordinates of the nth vertex.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the Z coordinates of the vertices. The nth element of
vectors x, y and z jointly represent the X, Y and Z
coordinates of the nth vertex.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zcalendar¶Sets the calendar system to use with z date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Ohlc(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
close¶Sets the close values.
The ‘close’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
closesrc¶Sets the source reference on Chart Studio Cloud for close.
The ‘closesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
decreasing¶The ‘decreasing’ property is an instance of Decreasing that may be specified as:
An instance of
plotly.graph_objects.ohlc.DecreasingA dict of string/value properties that will be passed to the Decreasing constructor
Supported dict properties:
- line
plotly.graph_objects.ohlc.decreasing.Li neinstance or dict with compatible properties
high¶Sets the high values.
The ‘high’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
highsrc¶Sets the source reference on Chart Studio Cloud for high.
The ‘highsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.ohlc.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.- split
Show hover information (open, close, high, low) in separate labels.
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
increasing¶The ‘increasing’ property is an instance of Increasing that may be specified as:
An instance of
plotly.graph_objects.ohlc.IncreasingA dict of string/value properties that will be passed to the Increasing constructor
Supported dict properties:
- line
plotly.graph_objects.ohlc.increasing.Li neinstance or dict with compatible properties
legend¶Sets the reference to a legend to show this trace 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 trace. 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.ohlc.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.ohlc.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- dash
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”). Note that this style setting can also be set per direction via
increasing.line.dashanddecreasing.line.dash.- width
[object Object] Note that this style setting can also be set per direction via
increasing.line.widthanddecreasing.line.width.
low¶Sets the low values.
The ‘low’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lowsrc¶Sets the source reference on Chart Studio Cloud for low.
The ‘lowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
open¶Sets the open values.
The ‘open’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
opensrc¶Sets the source reference on Chart Studio Cloud for open.
The ‘opensrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.ohlc.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickwidth¶Sets the width of the open/close tick marks relative to the “x” minimal interval.
An int or float in the interval [0, 0.5]
int|float
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates. If absent, linear coordinate will be generated.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Parcats(arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
arrangement¶Sets the drag interaction mode for categories and dimensions.
If perpendicular, the categories can only move along a line
perpendicular to the paths. If freeform, the categories can
freely move on the plane. If fixed, the categories and
dimensions are stationary.
[‘perpendicular’, ‘freeform’, ‘fixed’]
Any
bundlecolors¶Sort paths so that like colors are bundled together within each category.
The ‘bundlecolors’ property must be specified as a bool (either True, or False)
counts¶The number of observations represented by each state. Defaults to 1 so that each state represents one observation
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
countssrc¶Sets the source reference on Chart Studio Cloud for counts.
The ‘countssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dimensiondefaults¶When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions
The ‘dimensiondefaults’ property is an instance of Dimension that may be specified as:
An instance of
plotly.graph_objects.parcats.DimensionA dict of string/value properties that will be passed to the Dimension constructor
Supported dict properties:
dimensions¶The dimensions (variables) of the parallel categories diagram.
The ‘dimensions’ property is a tuple of instances of Dimension that may be specified as:
A list or tuple of instances of plotly.graph_objects.parcats.Dimension
A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor
Supported dict properties:
- categoryarray
Sets the order in which categories in this dimension appear. Only has an effect if
categoryorderis set to “array”. Used withcategoryorder.- categoryarraysrc
Sets the source reference on Chart Studio Cloud for
categoryarray.- categoryorder
Specifies the ordering logic for the categories in the dimension. By default, plotly uses “trace”, which specifies the order that is present in the data supplied. Set
categoryorderto category ascending or category descending if order should be determined by the alphanumerical order of the category names. Setcategoryorderto “array” to derive the ordering from the attributecategoryarray. If a category is not found in thecategoryarrayarray, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories incategoryarray.- displayindex
The display index of dimension, from left to right, zero indexed, defaults to dimension index.
- label
The shown name of the dimension.
- ticktext
Sets alternative tick labels for the categories in this dimension. Only has an effect if
categoryorderis set to “array”. Should be an array the same length ascategoryarrayUsed withcategoryorder.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- values
Dimension values.
values[n]represents the category value of then`th point in the dataset, therefore the `valuesvector for all dimensions must be the same (longer vectors will be truncated).- valuessrc
Sets the source reference on Chart Studio Cloud for
values.- visible
Shows the dimension when set to
true(the default). Hides the dimension forfalse.
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.parcats.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this parcats trace .
- row
If there is a layout grid, use the domain for this row in the grid for this parcats trace .
- x
Sets the horizontal domain of this parcats trace (in plot fraction).
- y
Sets the vertical domain of this parcats trace (in plot fraction).
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘count’, ‘probability’] joined with ‘+’ characters (e.g. ‘count+probability’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
Any
hoveron¶Sets the hover interaction mode for the parcats diagram. If
category, hover interaction take place per category. If
color, hover interactions take place per color per category.
If dimension, hover interactions take place across all
categories per dimension.
[‘category’, ‘color’, ‘dimension’]
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. This value
here applies when hovering over dimensions. Note that
*categorycount, “colorcount” and “bandcolorcount” are only
available when hoveron contains the “color” flagFinally, the
template string has access to variables count, probability,
category, categorycount, colorcount and bandcolorcount.
Anything contained in tag <extra> is displayed in the
secondary box, for example “<extra>{fullData.name}</extra>”. To
hide the secondary box completely, use an empty tag
<extra></extra>.
A string
A number that will be converted to a string
labelfont¶Sets the font for the dimension labels.
The ‘labelfont’ property is an instance of Labelfont that may be specified as:
An instance of
plotly.graph_objects.parcats.LabelfontA dict of string/value properties that will be passed to the Labelfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.parcats.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendwidth¶Sets the width (in px or fraction) of the legend for this trace.
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.parcats.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined byline.colorscale. Has an effect only if inline.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
line.color) or the bounds set inline.cminandline.cmaxHas an effect only if inline.coloris set to a numerical array. Defaults tofalsewhenline.cminandline.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
line.coloris set to a numerical array. Value should have the same units as inline.colorand if set,line.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
line.cminand/orline.cmaxto be equidistant to this point. Has an effect only if inline.coloris set to a numerical array. Value should have the same units as inline.color. Has no effect whenline.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
line.coloris set to a numerical array. Value should have the same units as inline.colorand if set,line.cmaxmust be set as well.- color
Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
line.cminandline.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.parcats.line.Color Barinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
line.coloris set to a numerical array. 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, useline.cminandline.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bl uered,Blues,Cividis,Earth,Electric,Greens,Greys ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri dis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- hovertemplate
Template string used for rendering the information that appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3- format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time- format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available inhovertemplateare the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs- events/#event-data. Additionally, every attributes that can be specified per-point (the ones that arearrayOk: true) are available. This value here applies when hovering over lines.Finally, the template string has access to variablescountandprobability. Anything contained in tag<extra>is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag<extra></extra>.- reversescale
Reverses the color mapping if true. Has an effect only if in
line.coloris set to a numerical array. If true,line.cminwill correspond to the last color in the array andline.cmaxwill correspond to the first color.- shape
Sets the shape of the paths. If
linear, paths are composed of straight lines. Ifhspline, paths are composed of horizontal curved splines- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
line.coloris set to a numerical array.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
sortpaths¶Sets the path sorting algorithm. If forward, sort paths based
on dimension categories from left to right. If backward, sort
paths based on dimensions categories from right to left.
[‘forward’, ‘backward’]
Any
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.parcats.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
tickfont¶Sets the font for the category labels.
The ‘tickfont’ property is an instance of Tickfont that may be specified as:
An instance of
plotly.graph_objects.parcats.TickfontA dict of string/value properties that will be passed to the Tickfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Parcoords(arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dimensiondefaults¶When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions
The ‘dimensiondefaults’ property is an instance of Dimension that may be specified as:
An instance of
plotly.graph_objects.parcoords.DimensionA dict of string/value properties that will be passed to the Dimension constructor
Supported dict properties:
dimensions¶The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.
The ‘dimensions’ property is a tuple of instances of Dimension that may be specified as:
A list or tuple of instances of plotly.graph_objects.parcoords.Dimension
A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor
Supported dict properties:
- constraintrange
The domain range to which the filter on the dimension is constrained. Must be an array of
[fromValue, toValue]withfromValue <= toValue, or ifmultiselectis not disabled, you may give an array of arrays, where each inner array is[fromValue, toValue].- label
The shown name of the dimension.
- multiselect
Do we allow multiple selection ranges or just a single range?
- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- range
The domain range that represents the full, shown axis extent. Defaults to the
valuesextent. Must be an array of[fromValue, toValue]with finite numbers as elements.- 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
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- ticktext
Sets the text displayed at the ticks position via
tickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear.
- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- values
Dimension values.
values[n]represents the value of then`th point in the dataset, therefore the `valuesvector for all dimensions must be the same (longer vectors will be truncated). Each value must be a finite number.- valuessrc
Sets the source reference on Chart Studio Cloud for
values.- visible
Shows the dimension when set to
true(the default). Hides the dimension forfalse.
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.parcoords.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this parcoords trace .
- row
If there is a layout grid, use the domain for this row in the grid for this parcoords trace .
- x
Sets the horizontal domain of this parcoords trace (in plot fraction).
- y
Sets the vertical domain of this parcoords trace (in plot fraction).
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
labelangle¶Sets the angle of the labels with respect to the horizontal.
For example, a tickangle of -90 draws the labels vertically.
Tilted labels with “labelangle” may be positioned better inside
margins when labelposition is set to “bottom”.
The ‘labelangle’ 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
labelfont¶Sets the font for the dimension labels.
The ‘labelfont’ property is an instance of Labelfont that may be specified as:
An instance of
plotly.graph_objects.parcoords.LabelfontA dict of string/value properties that will be passed to the Labelfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
labelside¶Specifies the location of the label. “top” positions labels
above, next to the title “bottom” positions labels below the
graph Tilted labels with “labelangle” may be positioned better
inside margins when labelposition is set to “bottom”.
[‘top’, ‘bottom’]
Any
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.parcoords.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.parcoords.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined byline.colorscale. Has an effect only if inline.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
line.color) or the bounds set inline.cminandline.cmaxHas an effect only if inline.coloris set to a numerical array. Defaults tofalsewhenline.cminandline.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
line.coloris set to a numerical array. Value should have the same units as inline.colorand if set,line.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
line.cminand/orline.cmaxto be equidistant to this point. Has an effect only if inline.coloris set to a numerical array. Value should have the same units as inline.color. Has no effect whenline.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
line.coloris set to a numerical array. Value should have the same units as inline.colorand if set,line.cmaxmust be set as well.- color
Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
line.cminandline.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.parcoords.line.Col orBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
line.coloris set to a numerical array. 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, useline.cminandline.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bl uered,Blues,Cividis,Earth,Electric,Greens,Greys ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri dis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- reversescale
Reverses the color mapping if true. Has an effect only if in
line.coloris set to a numerical array. If true,line.cminwill correspond to the last color in the array andline.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
line.coloris set to a numerical array.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
rangefont¶Sets the font for the dimension range values.
The ‘rangefont’ property is an instance of Rangefont that may be specified as:
An instance of
plotly.graph_objects.parcoords.RangefontA dict of string/value properties that will be passed to the Rangefont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.parcoords.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
tickfont¶Sets the font for the dimension tick values.
The ‘tickfont’ property is an instance of Tickfont that may be specified as:
An instance of
plotly.graph_objects.parcoords.TickfontA dict of string/value properties that will be passed to the Tickfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.parcoords.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- line
plotly.graph_objects.parcoords.unselect ed.Lineinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Pie(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
automargin¶Determines whether outside text labels can push the margins.
The ‘automargin’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
direction¶Specifies the direction at which succeeding sectors follow one another.
[‘clockwise’, ‘counterclockwise’]
Any
dlabel¶Sets the label step. See label0 for more info.
An int or float
int|float
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.pie.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this pie trace .
- row
If there is a layout grid, use the domain for this row in the grid for this pie trace .
- x
Sets the horizontal domain of this pie trace (in plot fraction).
- y
Sets the vertical domain of this pie trace (in plot fraction).
hole¶Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
An int or float in the interval [0, 1]
int|float
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘percent’, ‘name’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.pie.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables label, color,
value, percent and text. Anything contained in tag
<extra> is displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each sector. If a
single string, the same string appears for all data points. If
an array of string, the items are mapped in order of this
trace’s sectors. To be seen, trace hoverinfo must contain a
“text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextfont¶Sets the font used for textinfo lying inside the sector.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.pie.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
insidetextorientation¶Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.
[‘horizontal’, ‘radial’, ‘tangential’, ‘auto’]
Any
label0¶Alternate to labels. Builds a numeric set of labels. Use with
dlabel where label0 is the starting label and dlabel the
step.
An int or float
int|float
labels¶Sets the sector labels. If labels entries are duplicated, we
sum associated values or simply count occurrences if values
is not provided. For other array attributes (including color)
we use the first non-empty entry among all occurrences of the
label.
The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
labelssrc¶Sets the source reference on Chart Studio Cloud for labels.
The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.pie.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.pie.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- colors
Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
- colorssrc
Sets the source reference on Chart Studio Cloud for
colors.- line
plotly.graph_objects.pie.marker.Lineinstance or dict with compatible properties- pattern
Sets the pattern within the marker.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
outsidetextfont¶Sets the font used for textinfo lying outside the sector.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.pie.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
pull¶Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
An int or float in the interval [0, 1]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
pullsrc¶Sets the source reference on Chart Studio Cloud for pull.
The ‘pullsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
rotation¶Instead of the first slice starting at 12 o’clock, rotate to some other angle.
The ‘rotation’ 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
scalegroup¶If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
A string
A number that will be converted to a string
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
sort¶Determines whether or not the sectors are reordered from largest to smallest.
The ‘sort’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.pie.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each sector. If trace
textinfo contains a “text” flag, these elements will be seen
on the chart. If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in the
hover labels.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶Sets the font used for textinfo.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.pie.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph.
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘percent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textposition¶Specifies the location of the textinfo.
[‘inside’, ‘outside’, ‘auto’, ‘none’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables label,
color, value, percent and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.pie.TitleA dict of string/value properties that will be passed to the Title constructor
Supported dict properties:
- font
Sets the font used for
title.- position
Specifies the location of the
title.- text
Sets the title of the chart. If it is empty, no title is displayed.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
values¶Sets the values of the sectors. If omitted, we count occurrences of each label.
The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuessrc¶Sets the source reference on Chart Studio Cloud for values.
The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.RadialAxis(*args, **kwargs)¶Bases: dict
plotly.graph_objects.RadialAxis is deprecated.
plotly.graph_objects.layout.RadialAxis
plotly.graph_objects.layout.polar.RadialAxis
plotly.graph_objects.Sankey(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
arrangement¶If value is snap (the default), the node arrangement is
assisted by automatic snapping of elements to preserve space
between nodes specified via nodepad. If value is
perpendicular, the nodes can only move along a line
perpendicular to the flow. If value is freeform, the nodes
can freely move on the plane. If value is fixed, the nodes
are stationary.
[‘snap’, ‘perpendicular’, ‘freeform’, ‘fixed’]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.sankey.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this sankey trace .
- row
If there is a layout grid, use the domain for this row in the grid for this sankey trace .
- x
Sets the horizontal domain of this sankey trace (in plot fraction).
- y
Sets the vertical domain of this sankey trace (in plot fraction).
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
Note that this attribute is superseded by node.hoverinfo and
node.hoverinfo for nodes and links respectively.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [] joined with ‘+’ characters (e.g. ‘’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
Any
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.sankey.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.sankey.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
link¶The links of the Sankey plot.
The ‘link’ property is an instance of Link that may be specified as:
An instance of
plotly.graph_objects.sankey.LinkA dict of string/value properties that will be passed to the Link constructor
Supported dict properties:
- arrowlen
Sets the length (in px) of the links arrow, if 0 no arrow will be drawn.
- color
Sets the
linkcolor. It can be a single value, or an array for specifying color for eachlink. Iflink.coloris omitted, then by default, a translucent grey link will be used.- colorscales
A tuple of
plotly.graph_objects.sankey. link.Colorscaleinstances or dicts with compatible properties- colorscaledefaults
When used in a template (as layout.template.dat a.sankey.link.colorscaledefaults), sets the default property values to use for elements of sankey.link.colorscales
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- customdata
Assigns extra data to each link.
- customdatasrc
Sets the source reference on Chart Studio Cloud for
customdata.- hovercolor
Sets the
linkhover color. It can be a single value, or an array for specifying hover colors for eachlink. Iflink.hovercoloris omitted, then by default, links will become slightly more opaque when hovered over.- hovercolorsrc
Sets the source reference on Chart Studio Cloud for
hovercolor.- hoverinfo
Determines which trace information appear when hovering links. If
noneorskipare set, no information is displayed upon hovering. But, ifnoneis set, click and hover events are still fired.- hoverlabel
plotly.graph_objects.sankey.link.Hoverl abelinstance or dict with compatible properties- hovertemplate
Template string used for rendering the information that appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3- format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time- format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available inhovertemplateare the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs- events/#event-data. Additionally, every attributes that can be specified per-point (the ones that arearrayOk: true) are available. Variablessourceandtargetare node objects.Finally, the template string has access to variablesvalueandlabel. Anything contained in tag<extra>is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag<extra></extra>.- hovertemplatesrc
Sets the source reference on Chart Studio Cloud for
hovertemplate.- label
The shown name of the link.
- labelsrc
Sets the source reference on Chart Studio Cloud for
label.- line
plotly.graph_objects.sankey.link.Lineinstance or dict with compatible properties- source
An integer number
[0..nodes.length - 1]that represents the source node.- sourcesrc
Sets the source reference on Chart Studio Cloud for
source.- target
An integer number
[0..nodes.length - 1]that represents the target node.- targetsrc
Sets the source reference on Chart Studio Cloud for
target.- value
A numeric value representing the flow volume value.
- valuesrc
Sets the source reference on Chart Studio Cloud for
value.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
node¶The nodes of the Sankey plot.
The ‘node’ property is an instance of Node that may be specified as:
An instance of
plotly.graph_objects.sankey.NodeA dict of string/value properties that will be passed to the Node constructor
Supported dict properties:
- align
Sets the alignment method used to position the nodes along the horizontal axis.
- color
Sets the
nodecolor. It can be a single value, or an array for specifying color for eachnode. Ifnode.coloris omitted, then the defaultPlotlycolor palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- customdata
Assigns extra data to each node.
- customdatasrc
Sets the source reference on Chart Studio Cloud for
customdata.- groups
Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.
- hoverinfo
Determines which trace information appear when hovering nodes. If
noneorskipare set, no information is displayed upon hovering. But, ifnoneis set, click and hover events are still fired.- hoverlabel
plotly.graph_objects.sankey.node.Hoverl abelinstance or dict with compatible properties- hovertemplate
Template string used for rendering the information that appear on hover box. Note that this will override
hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3- format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time- format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available inhovertemplateare the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs- events/#event-data. Additionally, every attributes that can be specified per-point (the ones that arearrayOk: true) are available. VariablessourceLinksandtargetLinksare arrays of link objects.Finally, the template string has access to variablesvalueandlabel. Anything contained in tag<extra>is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag<extra></extra>.- hovertemplatesrc
Sets the source reference on Chart Studio Cloud for
hovertemplate.- label
The shown name of the node.
- labelsrc
Sets the source reference on Chart Studio Cloud for
label.- line
plotly.graph_objects.sankey.node.Lineinstance or dict with compatible properties- pad
Sets the padding (in px) between the
nodes.- thickness
Sets the thickness (in px) of the
nodes.- x
The normalized horizontal position of the node.
- xsrc
Sets the source reference on Chart Studio Cloud for
x.- y
The normalized vertical position of the node.
- ysrc
Sets the source reference on Chart Studio Cloud for
y.
orientation¶Sets the orientation of the Sankey diagram.
[‘v’, ‘h’]
Any
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.sankey.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
textfont¶Sets the font for node labels
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.sankey.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
valueformat¶Sets the value 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.
A string
A number that will be converted to a string
valuesuffix¶Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.
A string
A number that will be converted to a string
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scatter(arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
cliponaxis¶Determines whether or not markers and text nodes are clipped
about the subplot axes. To show markers and text nodes above
axis lines and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
error_x¶The ‘error_x’ property is an instance of ErrorX that may be specified as:
An instance of
plotly.graph_objects.scatter.ErrorXA dict of string/value properties that will be passed to the ErrorX constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
copy_ystyle
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
error_y¶The ‘error_y’ property is an instance of ErrorY that may be specified as:
An instance of
plotly.graph_objects.scatter.ErrorYA dict of string/value properties that will be passed to the ErrorY constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
fill¶Sets the area to fill with a solid color. Defaults to “none”
unless this trace is stacked, then it gets “tonexty”
(“tonextx”) if orientation is “v” (“h”) Use with fillcolor
if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0
respectively. “tonextx” and “tonexty” fill between the
endpoints of this trace and the endpoints of the trace before
it, connecting those endpoints with straight lines (to make a
stacked area graph); if there is no trace before it, they
behave like “tozerox” and “tozeroy”. “toself” connects the
endpoints of the trace (or each segment of the trace if it has
gaps) into a closed shape. “tonext” fills the space between two
traces if one completely encloses the other (eg consecutive
contour lines), and behaves like “toself” if there is no trace
before it. “tonext” should not be used if one trace does not
enclose the other. Traces in a stackgroup will only fill to
(or be filled to) other traces in the same group. With multiple
`stackgroup`s or some traces stacked and some not, if fill-
linked traces are not already consecutive, the later ones will
be pushed down in the drawing order.
[‘none’, ‘tozeroy’, ‘tozerox’, ‘tonexty’, ‘tonextx’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
fillgradient¶Sets a fill gradient. If not specified, the fillcolor is used instead.
The ‘fillgradient’ property is an instance of Fillgradient that may be specified as:
An instance of
plotly.graph_objects.scatter.FillgradientA dict of string/value properties that will be passed to the Fillgradient constructor
Supported dict properties:
- colorscale
Sets the fill gradient colors as a color scale. The color scale is interpreted as a gradient applied in the direction specified by “orientation”, from the lowest to the highest value of the scatter plot along that axis, or from the center to the most distant point from it, if orientation is “radial”.
- start
Sets the gradient start value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is “horizontal”, the gradient will be horizontal and start from the x-position given by start. If omitted, the gradient starts at the lowest value of the trace along the respective axis. Ignored if orientation is “radial”.
- stop
Sets the gradient end value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is “horizontal”, the gradient will be horizontal and end at the x-position given by end. If omitted, the gradient ends at the highest value of the trace along the respective axis. Ignored if orientation is “radial”.
- type
Sets the type/orientation of the color gradient for the fill. Defaults to “none”.
fillpattern¶Sets the pattern within the marker.
The ‘fillpattern’ property is an instance of Fillpattern that may be specified as:
An instance of
plotly.graph_objects.scatter.FillpatternA dict of string/value properties that will be passed to the Fillpattern constructor
Supported dict properties:
- bgcolor
When there is no colorscale sets the color of background pattern fill. Defaults to a
marker.colorbackground whenfillmodeis “overlay”. Otherwise, defaults to a transparent background.- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- fgcolor
When there is no colorscale sets the color of foreground pattern fill. Defaults to a
marker.colorbackground whenfillmodeis “replace”. Otherwise, defaults to dark grey or white to increase contrast with thebgcolor.- fgcolorsrc
Sets the source reference on Chart Studio Cloud for
fgcolor.- fgopacity
Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when
fillmodeis “overlay”. Otherwise, defaults to 1.- fillmode
Determines whether
marker.colorshould be used as a default tobgcoloror afgcolor.- shape
Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- shapesrc
Sets the source reference on Chart Studio Cloud for
shape.- size
Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- solidity
Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- soliditysrc
Sets the source reference on Chart Studio Cloud for
solidity.
groupnorm¶Only relevant when stackgroup is used, and only the first
groupnorm found in the stackgroup will be used - including
if visible is “legendonly” but not if it is false. Sets the
normalization for the sum of this stackgroup. With
“fraction”, the value of each trace at each location is divided
by the sum of all trace values at that location. “percent” is
the same but multiplied by 100 to show percentages. If there
are multiple subplots, or multiple `stackgroup`s on one
subplot, each will be normalized within its own set.
[‘’, ‘fraction’, ‘percent’]
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scatter.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scatter.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scatter.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- backoff
Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With “auto” the lines would trim before markers if
marker.anglerefis set to “previous”.- backoffsrc
Sets the source reference on Chart Studio Cloud for
backoff.- color
Sets the line color.
- dash
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”).
- shape
Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- simplify
Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.
- smoothing
Has an effect only if
shapeis set to “spline” Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a “linear” shape).- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatter.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- angleref
Sets the reference for marker angle. With “previous”, angle 0 points along the line from the previous point to this one. With “up”, angle 0 points toward the top of the screen.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scatter.marker.Col orBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- gradient
plotly.graph_objects.scatter.marker.Gra dientinstance or dict with compatible properties- line
plotly.graph_objects.scatter.marker.Lin einstance or dict with compatible properties- maxdisplayed
Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- standoff
Moves the marker away from the data point in the direction of
angle(in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.- standoffsrc
Sets the source reference on Chart Studio Cloud for
standoff.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶1. when scattermode is
set to “group”. 2. when stackgroup is used, and only the
first orientation found in the stackgroup will be used -
including if visible is “legendonly” but not if it is
false. Sets the stacking direction. With “v” (“h”), the y (x)
values of subsequent traces are added. Also affects the default
value of fill.
[‘v’, ‘h’]
Any
Only relevant in the following cases
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scatter.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatter.selected.M arkerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatter.selected.T extfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stackgaps¶Only relevant when stackgroup is used, and only the first
stackgaps found in the stackgroup will be used - including
if visible is “legendonly” but not if it is false.
Determines how we handle locations at which other traces in
this group have data but this one does not. With infer zero
we insert a zero at these locations. With “interpolate” we
linearly interpolate between existing values, and extrapolate a
constant beyond the existing values.
[‘infer zero’, ‘interpolate’]
Any
stackgroup¶Set several scatter traces (on the same subplot) to the same
stackgroup in order to add their y values (or their x values if
orientation is “h”). If blank or omitted this trace will not
be stacked. Stacking also turns fill on by default, using
“tonexty” (“tonextx”) if orientation is “h” (“v”) and sets
the default mode to “lines” irrespective of point count. You
can only stack on a numeric (linear or log) axis. Traces in a
stackgroup will only fill to (or be filled to) other traces
in the same group. With multiple `stackgroup`s or some traces
stacked and some not, if fill-linked traces are not already
consecutive, the later ones will be pushed down in the drawing
order.
A string
A number that will be converted to a string
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scatter.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatter.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scatter.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatter.unselected .Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatter.unselected .Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Scatter3d(arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
error_x¶The ‘error_x’ property is an instance of ErrorX that may be specified as:
An instance of
plotly.graph_objects.scatter3d.ErrorXA dict of string/value properties that will be passed to the ErrorX constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
copy_zstyle
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
error_y¶The ‘error_y’ property is an instance of ErrorY that may be specified as:
An instance of
plotly.graph_objects.scatter3d.ErrorYA dict of string/value properties that will be passed to the ErrorY constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
copy_zstyle
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
error_z¶The ‘error_z’ property is an instance of ErrorZ that may be specified as:
An instance of
plotly.graph_objects.scatter3d.ErrorZA dict of string/value properties that will be passed to the ErrorZ constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scatter3d.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets text elements associated with each (x,y,z) triplet. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y,z) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scatter3d.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scatter3d.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined byline.colorscale. Has an effect only if inline.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
line.color) or the bounds set inline.cminandline.cmaxHas an effect only if inline.coloris set to a numerical array. Defaults tofalsewhenline.cminandline.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
line.coloris set to a numerical array. Value should have the same units as inline.colorand if set,line.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
line.cminand/orline.cmaxto be equidistant to this point. Has an effect only if inline.coloris set to a numerical array. Value should have the same units as inline.color. Has no effect whenline.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
line.coloris set to a numerical array. Value should have the same units as inline.colorand if set,line.cmaxmust be set as well.- color
Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
line.cminandline.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scatter3d.line.Col orBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
line.coloris set to a numerical array. 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, useline.cminandline.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bl uered,Blues,Cividis,Earth,Electric,Greens,Greys ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri dis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- dash
Sets the dash style of the lines.
- reversescale
Reverses the color mapping if true. Has an effect only if in
line.coloris set to a numerical array. If true,line.cminwill correspond to the last color in the array andline.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
line.coloris set to a numerical array.- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatter3d.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scatter3d.marker.C olorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- line
plotly.graph_objects.scatter3d.marker.L ineinstance or dict with compatible properties- opacity
Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set “marker.color” to an rgba color and use its alpha channel.
- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- symbol
Sets the marker symbol type.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
projection¶The ‘projection’ property is an instance of Projection that may be specified as:
An instance of
plotly.graph_objects.scatter3d.ProjectionA dict of string/value properties that will be passed to the Projection constructor
Supported dict properties:
- x
plotly.graph_objects.scatter3d.projecti on.Xinstance or dict with compatible properties- y
plotly.graph_objects.scatter3d.projecti on.Yinstance or dict with compatible properties- z
plotly.graph_objects.scatter3d.projecti on.Zinstance or dict with compatible properties
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scatter3d.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
surfaceaxis¶If “-1”, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.
[-1, 0, 1, 2]
Any
surfacecolor¶Sets the surface fill color.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
text¶Sets text elements associated with each (x,y,z) triplet. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y,z) coordinates. If trace hoverinfo
contains a “text” flag and “hovertext” is not set, these
elements will be seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatter3d.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the z coordinates.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zcalendar¶Sets the calendar system to use with z date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Scattercarpet(arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
a¶Sets the a-axis coordinates.
The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
asrc¶Sets the source reference on Chart Studio Cloud for a.
The ‘asrc’ property must be specified as a string or as a plotly.grid_objs.Column object
b¶Sets the b-axis coordinates.
The ‘b’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
bsrc¶Sets the source reference on Chart Studio Cloud for b.
The ‘bsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
carpet¶An identifier for this carpet, so that scattercarpet and
contourcarpet traces can specify a carpet plot on which they
lie
A string
A number that will be converted to a string
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. scatterternary has a subset of the options
available to scatter. “toself” connects the endpoints of the
trace (or each segment of the trace if it has gaps) into a
closed shape. “tonext” fills the space between two traces if
one completely encloses the other (eg consecutive contour
lines), and behaves like “toself” if there is no trace before
it. “tonext” should not be used if one trace does not enclose
the other.
[‘none’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘a’, ‘b’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘a+b’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scattercarpet.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (a,b) point. If a
single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b). To be seen, trace hoverinfo
must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scattercarpet.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scattercarpet.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- backoff
Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With “auto” the lines would trim before markers if
marker.anglerefis set to “previous”.- backoffsrc
Sets the source reference on Chart Studio Cloud for
backoff.- color
Sets the line color.
- dash
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”).
- shape
Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- smoothing
Has an effect only if
shapeis set to “spline” Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a “linear” shape).- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scattercarpet.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- angleref
Sets the reference for marker angle. With “previous”, angle 0 points along the line from the previous point to this one. With “up”, angle 0 points toward the top of the screen.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scattercarpet.mark er.ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- gradient
plotly.graph_objects.scattercarpet.mark er.Gradientinstance or dict with compatible properties- line
plotly.graph_objects.scattercarpet.mark er.Lineinstance or dict with compatible properties- maxdisplayed
Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- standoff
Moves the marker away from the data point in the direction of
angle(in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.- standoffsrc
Sets the source reference on Chart Studio Cloud for
standoff.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scattercarpet.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattercarpet.sele cted.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattercarpet.sele cted.Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scattercarpet.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (a,b) point. If a
single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b). If trace hoverinfo contains
a “text” flag and “hovertext” is not set, these elements will
be seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scattercarpet.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables a, b
and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scattercarpet.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattercarpet.unse lected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattercarpet.unse lected.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Scattergeo(arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
featureidkey¶Sets the key in GeoJSON features which is used as id to match
the items included in the locations array. Only has an effect
when geojson is set. Support nested property, for example
“properties.name”.
A string
A number that will be converted to a string
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. “toself” connects the endpoints of the trace (or
each segment of the trace if it has gaps) into a closed shape.
[‘none’, ‘toself’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
geo¶Sets a reference between this trace’s geospatial coordinates
and a geographic map. If “geo” (the default value), the
geospatial coordinates refer to layout.geo. If “geo2”, the
geospatial coordinates refer to layout.geo2, and so on.
The ‘geo’ property is an identifier of a particular subplot, of type ‘geo’, that may be specified as the string ‘geo’ optionally followed by an integer >= 1 (e.g. ‘geo’, ‘geo1’, ‘geo2’, ‘geo3’, etc.)
geojson¶Sets optional GeoJSON data associated with this trace. If not
given, the features on the base map are used when locations
is set. It can be set as a valid GeoJSON object or as a URL
string. Note that we only accept GeoJSONs of type
“FeatureCollection” or “Feature” with geometries of type
“Polygon” or “MultiPolygon”.
The ‘geojson’ property accepts values of any type
Any
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lon’, ‘lat’, ‘location’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘lon+lat’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scattergeo.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (lon,lat) pair or
item in locations. If a single string, the same string
appears over all the data points. If an array of string, the
items are mapped in order to the this trace’s (lon,lat) or
locations coordinates. To be seen, trace hoverinfo must
contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
lat¶Sets the latitude coordinates (in degrees North).
The ‘lat’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
latsrc¶Sets the source reference on Chart Studio Cloud for lat.
The ‘latsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scattergeo.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scattergeo.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the line color.
- dash
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”).
- width
Sets the line width (in px).
locationmode¶Determines the set of locations used to match entries in
locations to regions on the map. Values “ISO-3”, “USA-
states”, country names correspond to features on the base map
and value “geojson-id” corresponds to features from a custom
GeoJSON linked to the geojson attribute.
[‘ISO-3’, ‘USA-states’, ‘country names’, ‘geojson-id’]
Any
locations¶Sets the coordinates via location IDs or names. Coordinates
correspond to the centroid of each location given. See
locationmode for more info.
The ‘locations’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
locationssrc¶Sets the source reference on Chart Studio Cloud for
locations.
The ‘locationssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
lon¶Sets the longitude coordinates (in degrees East).
The ‘lon’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lonsrc¶Sets the source reference on Chart Studio Cloud for lon.
The ‘lonsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scattergeo.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- angleref
Sets the reference for marker angle. With “previous”, angle 0 points along the line from the previous point to this one. With “up”, angle 0 points toward the top of the screen. With “north”, angle 0 points north based on the current map projection.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scattergeo.marker. ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- gradient
plotly.graph_objects.scattergeo.marker. Gradientinstance or dict with compatible properties- line
plotly.graph_objects.scattergeo.marker. Lineinstance or dict with compatible properties- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- standoff
Moves the marker away from the data point in the direction of
angle(in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.- standoffsrc
Sets the source reference on Chart Studio Cloud for
standoff.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scattergeo.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattergeo.selecte d.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattergeo.selecte d.Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scattergeo.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (lon,lat) pair or item
in locations. If a single string, the same string appears
over all the data points. If an array of string, the items are
mapped in order to the this trace’s (lon,lat) or locations
coordinates. If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in the
hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scattergeo.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables lat,
lon, location and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scattergeo.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattergeo.unselec ted.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattergeo.unselec ted.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scattergl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
error_x¶The ‘error_x’ property is an instance of ErrorX that may be specified as:
An instance of
plotly.graph_objects.scattergl.ErrorXA dict of string/value properties that will be passed to the ErrorX constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
copy_ystyle
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
error_y¶The ‘error_y’ property is an instance of ErrorY that may be specified as:
An instance of
plotly.graph_objects.scattergl.ErrorYA dict of string/value properties that will be passed to the ErrorY constructor
Supported dict properties:
- array
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- arrayminussrc
Sets the source reference on Chart Studio Cloud for
arrayminus.- arraysrc
Sets the source reference on Chart Studio Cloud for
array.- color
Sets the stroke color of the error bars.
- symmetric
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Sets the thickness (in px) of the error bars.
traceref
tracerefminus
- type
Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in
value. If “percent”, the bar lengths correspond to a percentage of underlying data. Set this percentage invalue. If “sqrt”, the bar lengths correspond to the square of the underlying data. If “data”, the bar lengths are set with data setarray.- value
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars.- valueminus
Sets the value of either the percentage (if
typeis set to “percent”) or the constant (iftypeis set to “constant”) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars- visible
Determines whether or not this set of error bars is visible.
- width
Sets the width (in px) of the cross-bar at both ends of the error bars.
fill¶Sets the area to fill with a solid color. Defaults to “none”
unless this trace is stacked, then it gets “tonexty”
(“tonextx”) if orientation is “v” (“h”) Use with fillcolor
if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0
respectively. “tonextx” and “tonexty” fill between the
endpoints of this trace and the endpoints of the trace before
it, connecting those endpoints with straight lines (to make a
stacked area graph); if there is no trace before it, they
behave like “tozerox” and “tozeroy”. “toself” connects the
endpoints of the trace (or each segment of the trace if it has
gaps) into a closed shape. “tonext” fills the space between two
traces if one completely encloses the other (eg consecutive
contour lines), and behaves like “toself” if there is no trace
before it. “tonext” should not be used if one trace does not
enclose the other. Traces in a stackgroup will only fill to
(or be filled to) other traces in the same group. With multiple
`stackgroup`s or some traces stacked and some not, if fill-
linked traces are not already consecutive, the later ones will
be pushed down in the drawing order.
[‘none’, ‘tozeroy’, ‘tozerox’, ‘tonexty’, ‘tonextx’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scattergl.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scattergl.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scattergl.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the line color.
- dash
Sets the style of the lines.
- shape
Determines the line shape. The values correspond to step-wise line shapes.
- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scattergl.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scattergl.marker.C olorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- line
plotly.graph_objects.scattergl.marker.L ineinstance or dict with compatible properties- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scattergl.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattergl.selected .Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattergl.selected .Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scattergl.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scattergl.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scattergl.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattergl.unselect ed.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattergl.unselect ed.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
plotly.graph_objects.Scattermap(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
below¶Determines if this scattermap trace’s layers are to be inserted
before the layer with the specified ID. By default, scattermap
layers are inserted above all the base layers. To place the
scattermap layers above every other layer, set below to “’’”.
A string
A number that will be converted to a string
cluster¶The ‘cluster’ property is an instance of Cluster that may be specified as:
An instance of
plotly.graph_objects.scattermap.ClusterA dict of string/value properties that will be passed to the Cluster constructor
Supported dict properties:
- color
Sets the color for each cluster step.
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- enabled
Determines whether clustering is enabled or disabled.
- maxzoom
Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- size
Sets the size for each cluster step.
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- step
Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for
sizeand / orcolor. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.- stepsrc
Sets the source reference on Chart Studio Cloud for
step.
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. “toself” connects the endpoints of the trace (or
each segment of the trace if it has gaps) into a closed shape.
[‘none’, ‘toself’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lon’, ‘lat’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘lon+lat’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scattermap.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (lon,lat) pair If
a single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
lat¶Sets the latitude coordinates (in degrees North).
The ‘lat’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
latsrc¶Sets the source reference on Chart Studio Cloud for lat.
The ‘latsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scattermap.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scattermap.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the line color.
- width
Sets the line width (in px).
lon¶Sets the longitude coordinates (in degrees East).
The ‘lon’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lonsrc¶Sets the source reference on Chart Studio Cloud for lon.
The ‘lonsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scattermap.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- allowoverlap
Flag to draw all symbols, even if they overlap.
- angle
Sets the marker orientation from true North, in degrees clockwise. When using the “auto” default, no rotation would be applied in perspective views which is different from using a zero angle.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scattermap.marker. ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- symbol
Sets the marker symbol. Full list: https://www.map.com/maki-icons/ Note that the array
marker.colorandmarker.sizeare only available for “circle” symbols.- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scattermap.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattermap.selecte d.Markerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scattermap.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
map subplot. If “map” (the default value), the data refer to
layout.map. If “map2”, the data refer to layout.map2, and
so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘map’, that may be specified as the string ‘map’ optionally followed by an integer >= 1 (e.g. ‘map’, ‘map1’, ‘map2’, ‘map3’, etc.)
text¶Sets text elements associated with each (lon,lat) pair If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. If trace hoverinfo
contains a “text” flag and “hovertext” is not set, these
elements will be seen in the hover labels.
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
textfont¶Sets the icon text font (color=map.layer.paint.text-color,
size=map.layer.layout.text-size). Has an effect only when
type is set to “symbol”.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scattermap.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- weight
Sets the weight (or boldness) of the font.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
Any
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables lat,
lon and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scattermap.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattermap.unselec ted.Markerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scattermapbox(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
below¶Determines if this scattermapbox trace’s layers are to be
inserted before the layer with the specified ID. By default,
scattermapbox layers are inserted above all the base layers. To
place the scattermapbox layers above every other layer, set
below to “’’”.
A string
A number that will be converted to a string
cluster¶The ‘cluster’ property is an instance of Cluster that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.ClusterA dict of string/value properties that will be passed to the Cluster constructor
Supported dict properties:
- color
Sets the color for each cluster step.
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- enabled
Determines whether clustering is enabled or disabled.
- maxzoom
Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- size
Sets the size for each cluster step.
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- step
Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for
sizeand / orcolor. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.- stepsrc
Sets the source reference on Chart Studio Cloud for
step.
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. “toself” connects the endpoints of the trace (or
each segment of the trace if it has gaps) into a closed shape.
[‘none’, ‘toself’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lon’, ‘lat’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘lon+lat’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (lon,lat) pair If
a single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
lat¶Sets the latitude coordinates (in degrees North).
The ‘lat’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
latsrc¶Sets the source reference on Chart Studio Cloud for lat.
The ‘latsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scattermapbox.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scattermapbox.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the line color.
- width
Sets the line width (in px).
lon¶Sets the longitude coordinates (in degrees East).
The ‘lon’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
lonsrc¶Sets the source reference on Chart Studio Cloud for lon.
The ‘lonsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- allowoverlap
Flag to draw all symbols, even if they overlap.
- angle
Sets the marker orientation from true North, in degrees clockwise. When using the “auto” default, no rotation would be applied in perspective views which is different from using a zero angle.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scattermapbox.mark er.ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- symbol
Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array
marker.colorandmarker.sizeare only available for “circle” symbols.- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattermapbox.sele cted.Markerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶mapbox subplots and traces are deprecated! Please consider
switching to map subplots and traces. Learn more at:
https://plotly.com/python/maplibre-migration/ as well as
https://plotly.com/javascript/maplibre-migration/ Sets a
reference between this trace’s data coordinates and a mapbox
subplot. If “mapbox” (the default value), the data refer to
layout.mapbox. If “mapbox2”, the data refer to
layout.mapbox2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘mapbox’, that may be specified as the string ‘mapbox’ optionally followed by an integer >= 1 (e.g. ‘mapbox’, ‘mapbox1’, ‘mapbox2’, ‘mapbox3’, etc.)
text¶Sets text elements associated with each (lon,lat) pair If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (lon,lat) coordinates. If trace hoverinfo
contains a “text” flag and “hovertext” is not set, these
elements will be seen in the hover labels.
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
textfont¶Sets the icon text font (color=mapbox.layer.paint.text-color,
size=mapbox.layer.layout.text-size). Has an effect only when
type is set to “symbol”.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- weight
Sets the weight (or boldness) of the font.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
Any
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables lat,
lon and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scattermapbox.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattermapbox.unse lected.Markerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scatterpolar(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
cliponaxis¶Determines whether or not markers and text nodes are clipped
about the subplot axes. To show markers and text nodes above
axis lines and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dr¶Sets the r coordinate step.
An int or float
int|float
dtheta¶Sets the theta coordinate step. By default, the dtheta step
equals the subplot’s period divided by the length of the r
coordinates.
An int or float
int|float
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. scatterpolar has a subset of the options
available to scatter. “toself” connects the endpoints of the
trace (or each segment of the trace if it has gaps) into a
closed shape. “tonext” fills the space between two traces if
one completely encloses the other (eg consecutive contour
lines), and behaves like “toself” if there is no trace before
it. “tonext” should not be used if one trace does not enclose
the other.
[‘none’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘r’, ‘theta’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘r+theta’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scatterpolar.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scatterpolar.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scatterpolar.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- backoff
Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With “auto” the lines would trim before markers if
marker.anglerefis set to “previous”.- backoffsrc
Sets the source reference on Chart Studio Cloud for
backoff.- color
Sets the line color.
- dash
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”).
- shape
Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- smoothing
Has an effect only if
shapeis set to “spline” Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a “linear” shape).- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatterpolar.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- angleref
Sets the reference for marker angle. With “previous”, angle 0 points along the line from the previous point to this one. With “up”, angle 0 points toward the top of the screen.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scatterpolar.marke r.ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- gradient
plotly.graph_objects.scatterpolar.marke r.Gradientinstance or dict with compatible properties- line
plotly.graph_objects.scatterpolar.marke r.Lineinstance or dict with compatible properties- maxdisplayed
Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- standoff
Moves the marker away from the data point in the direction of
angle(in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.- standoffsrc
Sets the source reference on Chart Studio Cloud for
standoff.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
r¶Sets the radial coordinates
The ‘r’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
r0¶Alternate to r. Builds a linear space of r coordinates. Use
with dr where r0 is the starting coordinate and dr the
step.
The ‘r0’ property accepts values of any type
Any
rsrc¶Sets the source reference on Chart Studio Cloud for r.
The ‘rsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scatterpolar.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatterpolar.selec ted.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatterpolar.selec ted.Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scatterpolar.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
polar subplot. If “polar” (the default value), the data refer
to layout.polar. If “polar2”, the data refer to
layout.polar2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘polar’, that may be specified as the string ‘polar’ optionally followed by an integer >= 1 (e.g. ‘polar’, ‘polar1’, ‘polar2’, ‘polar3’, etc.)
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatterpolar.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables r,
theta and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
theta¶Sets the angular coordinates
The ‘theta’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
theta0¶Alternate to theta. Builds a linear space of theta
coordinates. Use with dtheta where theta0 is the starting
coordinate and dtheta the step.
The ‘theta0’ property accepts values of any type
Any
thetasrc¶Sets the source reference on Chart Studio Cloud for theta.
The ‘thetasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
thetaunit¶Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.
[‘radians’, ‘degrees’, ‘gradians’]
Any
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scatterpolar.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatterpolar.unsel ected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatterpolar.unsel ected.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scatterpolargl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
dr¶Sets the r coordinate step.
An int or float
int|float
dtheta¶Sets the theta coordinate step. By default, the dtheta step
equals the subplot’s period divided by the length of the r
coordinates.
An int or float
int|float
fill¶Sets the area to fill with a solid color. Defaults to “none”
unless this trace is stacked, then it gets “tonexty”
(“tonextx”) if orientation is “v” (“h”) Use with fillcolor
if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0
respectively. “tonextx” and “tonexty” fill between the
endpoints of this trace and the endpoints of the trace before
it, connecting those endpoints with straight lines (to make a
stacked area graph); if there is no trace before it, they
behave like “tozerox” and “tozeroy”. “toself” connects the
endpoints of the trace (or each segment of the trace if it has
gaps) into a closed shape. “tonext” fills the space between two
traces if one completely encloses the other (eg consecutive
contour lines), and behaves like “toself” if there is no trace
before it. “tonext” should not be used if one trace does not
enclose the other. Traces in a stackgroup will only fill to
(or be filled to) other traces in the same group. With multiple
`stackgroup`s or some traces stacked and some not, if fill-
linked traces are not already consecutive, the later ones will
be pushed down in the drawing order.
[‘none’, ‘tozeroy’, ‘tozerox’, ‘tonexty’, ‘tonextx’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘r’, ‘theta’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘r+theta’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scatterpolargl.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scatterpolargl.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scatterpolargl.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the line color.
- dash
Sets the style of the lines.
- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatterpolargl.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scatterpolargl.mar ker.ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- line
plotly.graph_objects.scatterpolargl.mar ker.Lineinstance or dict with compatible properties- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
r¶Sets the radial coordinates
The ‘r’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
r0¶Alternate to r. Builds a linear space of r coordinates. Use
with dr where r0 is the starting coordinate and dr the
step.
The ‘r0’ property accepts values of any type
Any
rsrc¶Sets the source reference on Chart Studio Cloud for r.
The ‘rsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scatterpolargl.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatterpolargl.sel ected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatterpolargl.sel ected.Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scatterpolargl.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
polar subplot. If “polar” (the default value), the data refer
to layout.polar. If “polar2”, the data refer to
layout.polar2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘polar’, that may be specified as the string ‘polar’ optionally followed by an integer >= 1 (e.g. ‘polar’, ‘polar1’, ‘polar2’, ‘polar3’, etc.)
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatterpolargl.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables r,
theta and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
theta¶Sets the angular coordinates
The ‘theta’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
theta0¶Alternate to theta. Builds a linear space of theta
coordinates. Use with dtheta where theta0 is the starting
coordinate and dtheta the step.
The ‘theta0’ property accepts values of any type
Any
thetasrc¶Sets the source reference on Chart Studio Cloud for theta.
The ‘thetasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
thetaunit¶Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.
[‘radians’, ‘degrees’, ‘gradians’]
Any
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scatterpolargl.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatterpolargl.uns elected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatterpolargl.uns elected.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scattersmith(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
cliponaxis¶Determines whether or not markers and text nodes are clipped
about the subplot axes. To show markers and text nodes above
axis lines and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. scattersmith has a subset of the options
available to scatter. “toself” connects the endpoints of the
trace (or each segment of the trace if it has gaps) into a
closed shape. “tonext” fills the space between two traces if
one completely encloses the other (eg consecutive contour
lines), and behaves like “toself” if there is no trace before
it. “tonext” should not be used if one trace does not enclose
the other.
[‘none’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘real’, ‘imag’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘real+imag’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scattersmith.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
imag¶Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.
The ‘imag’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
imagsrc¶Sets the source reference on Chart Studio Cloud for imag.
The ‘imagsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scattersmith.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scattersmith.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- backoff
Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With “auto” the lines would trim before markers if
marker.anglerefis set to “previous”.- backoffsrc
Sets the source reference on Chart Studio Cloud for
backoff.- color
Sets the line color.
- dash
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”).
- shape
Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- smoothing
Has an effect only if
shapeis set to “spline” Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a “linear” shape).- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scattersmith.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- angleref
Sets the reference for marker angle. With “previous”, angle 0 points along the line from the previous point to this one. With “up”, angle 0 points toward the top of the screen.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scattersmith.marke r.ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- gradient
plotly.graph_objects.scattersmith.marke r.Gradientinstance or dict with compatible properties- line
plotly.graph_objects.scattersmith.marke r.Lineinstance or dict with compatible properties- maxdisplayed
Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- standoff
Moves the marker away from the data point in the direction of
angle(in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.- standoffsrc
Sets the source reference on Chart Studio Cloud for
standoff.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
real¶Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.
The ‘real’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
realsrc¶Sets the source reference on Chart Studio Cloud for real.
The ‘realsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scattersmith.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattersmith.selec ted.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattersmith.selec ted.Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scattersmith.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
smith subplot. If “smith” (the default value), the data refer
to layout.smith. If “smith2”, the data refer to
layout.smith2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘smith’, that may be specified as the string ‘smith’ optionally followed by an integer >= 1 (e.g. ‘smith’, ‘smith1’, ‘smith2’, ‘smith3’, etc.)
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scattersmith.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables real,
imag and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scattersmith.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scattersmith.unsel ected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scattersmith.unsel ected.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scatterternary(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
a¶Sets the quantity of component a in each data point. If a,
b, and c are all provided, they need not be normalized,
only the relative values matter. If only two arrays are
provided they must be normalized to match ternary<i>.sum.
The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
asrc¶Sets the source reference on Chart Studio Cloud for a.
The ‘asrc’ property must be specified as a string or as a plotly.grid_objs.Column object
b¶Sets the quantity of component a in each data point. If a,
b, and c are all provided, they need not be normalized,
only the relative values matter. If only two arrays are
provided they must be normalized to match ternary<i>.sum.
The ‘b’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
bsrc¶Sets the source reference on Chart Studio Cloud for b.
The ‘bsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
c¶Sets the quantity of component a in each data point. If a,
b, and c are all provided, they need not be normalized,
only the relative values matter. If only two arrays are
provided they must be normalized to match ternary<i>.sum.
The ‘c’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
cliponaxis¶Determines whether or not markers and text nodes are clipped
about the subplot axes. To show markers and text nodes above
axis lines and tick labels, make sure to set xaxis.layer and
yaxis.layer to below traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
csrc¶Sets the source reference on Chart Studio Cloud for c.
The ‘csrc’ property must be specified as a string or as a plotly.grid_objs.Column object
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
fill¶Sets the area to fill with a solid color. Use with fillcolor
if not “none”. scatterternary has a subset of the options
available to scatter. “toself” connects the endpoints of the
trace (or each segment of the trace if it has gaps) into a
closed shape. “tonext” fills the space between two traces if
one completely encloses the other (eg consecutive contour
lines), and behaves like “toself” if there is no trace before
it. “tonext” should not be used if one trace does not enclose
the other.
[‘none’, ‘toself’, ‘tonext’]
Any
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘a’, ‘b’, ‘c’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘a+b’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.scatterternary.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (a,b,c) point. If
a single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b,c). To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.scatterternary.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.scatterternary.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- backoff
Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With “auto” the lines would trim before markers if
marker.anglerefis set to “previous”.- backoffsrc
Sets the source reference on Chart Studio Cloud for
backoff.- color
Sets the line color.
- dash
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”).
- shape
Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- smoothing
Has an effect only if
shapeis set to “spline” Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a “linear” shape).- width
Sets the line width (in px).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatterternary.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- angleref
Sets the reference for marker angle. With “previous”, angle 0 points along the line from the previous point to this one. With “up”, angle 0 points toward the top of the screen.
- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.scatterternary.mar ker.ColorBarinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- gradient
plotly.graph_objects.scatterternary.mar ker.Gradientinstance or dict with compatible properties- line
plotly.graph_objects.scatterternary.mar ker.Lineinstance or dict with compatible properties- maxdisplayed
Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.
- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- standoff
Moves the marker away from the data point in the direction of
angle(in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.- standoffsrc
Sets the source reference on Chart Studio Cloud for
standoff.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
mode¶Determines the drawing mode for this scatter trace. If the
provided mode includes “text” then the text elements appear
at the coordinates. Otherwise, the text elements appear on
hover. If there are less than 20 points and the trace is not
stacked then the default is “lines+markers”. Otherwise,
“lines”.
The ‘mode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.scatterternary.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatterternary.sel ected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatterternary.sel ected.Textfontinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.scatterternary.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
subplot¶Sets a reference between this trace’s data coordinates and a
ternary subplot. If “ternary” (the default value), the data
refer to layout.ternary. If “ternary2”, the data refer to
layout.ternary2, and so on.
The ‘subplot’ property is an identifier of a particular subplot, of type ‘ternary’, that may be specified as the string ‘ternary’ optionally followed by an integer >= 1 (e.g. ‘ternary’, ‘ternary1’, ‘ternary2’, ‘ternary3’, etc.)
sum¶The number each triplet should sum to, if only two of a, b,
and c are provided. This overrides ternary<i>.sum to
normalize this specific trace, but does not affect the values
displayed on the axes. 0 (or missing) means to use
ternary<i>.sum
An int or float in the interval [0, inf]
int|float
text¶Sets text elements associated with each (a,b,c) point. If a
single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b,c). If trace hoverinfo
contains a “text” flag and “hovertext” is not set, these
elements will be seen in the hover labels.
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
textfont¶Sets the text font.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatterternary.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textposition¶Sets the positions of the text elements with respects to the
(x,y) coordinates.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables a, b,
c and text.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.scatterternary.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.scatterternary.uns elected.Markerinstance or dict with compatible properties- textfont
plotly.graph_objects.scatterternary.uns elected.Textfontinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Scene(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Scene is deprecated.
plotly.graph_objects.layout.Scene
plotly.graph_objects.Splom(arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
diagonal¶The ‘diagonal’ property is an instance of Diagonal that may be specified as:
An instance of
plotly.graph_objects.splom.DiagonalA dict of string/value properties that will be passed to the Diagonal constructor
Supported dict properties:
- visible
Determines whether or not subplots on the diagonal are displayed.
dimensiondefaults¶When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions
The ‘dimensiondefaults’ property is an instance of Dimension that may be specified as:
An instance of
plotly.graph_objects.splom.DimensionA dict of string/value properties that will be passed to the Dimension constructor
Supported dict properties:
dimensions¶The ‘dimensions’ property is a tuple of instances of Dimension that may be specified as:
A list or tuple of instances of plotly.graph_objects.splom.Dimension
A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor
Supported dict properties:
- axis
plotly.graph_objects.splom.dimension.Ax isinstance or dict with compatible properties- label
Sets the label corresponding to this splom dimension.
- 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
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- templateitemname
Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- values
Sets the dimension values to be plotted.
- valuessrc
Sets the source reference on Chart Studio Cloud for
values.- visible
Determines whether or not this dimension is shown on the graph. Note that even visible false dimension contribute to the default grid generate by this splom trace.
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.splom.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.splom.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.splom.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- anglesrc
Sets the source reference on Chart Studio Cloud for
angle.- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if inmarker.coloris set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.color) or the bounds set inmarker.cminandmarker.cmaxHas an effect only if inmarker.coloris set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if inmarker.coloris set to a numerical array. Value should have the same units as inmarker.color. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if in
marker.coloris set to a numerical array. Value should have the same units as inmarker.colorand if set,marker.cmaxmust be set as well.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.splom.marker.Color Barinstance or dict with compatible properties- colorscale
Sets the colorscale. Has an effect only if in
marker.coloris set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- line
plotly.graph_objects.splom.marker.Lineinstance or dict with compatible properties- opacity
Sets the marker opacity.
- opacitysrc
Sets the source reference on Chart Studio Cloud for
opacity.- reversescale
Reverses the color mapping if true. Has an effect only if in
marker.coloris set to a numerical array. If true,marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in
marker.coloris set to a numerical array.- size
Sets the marker size (in px).
- sizemin
Has an effect only if
marker.sizeis set to a numerical array. Sets the minimum size (in px) of the rendered marker points.- sizemode
Has an effect only if
marker.sizeis set to a numerical array. Sets the rule for which the data insizeis converted to pixels.- sizeref
Has an effect only if
marker.sizeis set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use withsizeminandsizemode.- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
- symbolsrc
Sets the source reference on Chart Studio Cloud for
symbol.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.splom.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.splom.selected.Mar kerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showlowerhalf¶Determines whether or not subplots on the lower half from the diagonal are displayed.
The ‘showlowerhalf’ property must be specified as a bool (either True, or False)
showupperhalf¶Determines whether or not subplots on the upper half from the diagonal are displayed.
The ‘showupperhalf’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.splom.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.splom.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.splom.unselected.M arkerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
xaxes¶Sets the list of x axes corresponding to dimensions of this
splom trace. By default, a splom will match the first N xaxes
where N is the number of input dimensions. Note that, in case
where diagonal.visible is false and showupperhalf or
showlowerhalf is false, this splom trace will generate one
less x-axis and one less y-axis.
The ‘xaxes’ property is an info array that may be specified as: * a list of elements where:
The ‘xaxes[i]’ property is an identifier of a particular
subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
yaxes¶Sets the list of y axes corresponding to dimensions of this
splom trace. By default, a splom will match the first N yaxes
where N is the number of input dimensions. Note that, in case
where diagonal.visible is false and showupperhalf or
showlowerhalf is false, this splom trace will generate one
less x-axis and one less y-axis.
The ‘yaxes’ property is an info array that may be specified as: * a list of elements where:
The ‘yaxes[i]’ property is an identifier of a particular
subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Stream(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Stream is deprecated.
plotly.graph_objects.scatter.Stream
plotly.graph_objects.area.Stream
plotly.graph_objects.Streamtube(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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 u/v/w norm) 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 u/v/w norm 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 u/v/w norm. 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 u/v/w norm and if set, cmax must be set as
well.
An int or float
int|float
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.streamtube.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.streamt ube.colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.streamtube.colorbar.tickformatstopdefaults), sets the default property values to use for elements of streamtube.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.streamtube.colorba r.Titleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘u’, ‘v’, ‘w’, ‘norm’, ‘divergence’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.streamtube.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables tubex, tubey,
tubez, tubeu, tubev, tubew, norm and divergence.
Anything contained in tag <extra> is displayed in the
secondary box, for example “<extra>{fullData.name}</extra>”. To
hide the secondary box completely, use an empty tag
<extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
A string
A number that will be converted to a string
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.streamtube.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lighting¶The ‘lighting’ property is an instance of Lighting that may be specified as:
An instance of
plotly.graph_objects.streamtube.LightingA dict of string/value properties that will be passed to the Lighting constructor
Supported dict properties:
- ambient
Ambient light increases overall color visibility but can wash out the image.
- diffuse
Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
lightposition¶The ‘lightposition’ property is an instance of Lightposition that may be specified as:
An instance of
plotly.graph_objects.streamtube.LightpositionA dict of string/value properties that will be passed to the Lightposition constructor
Supported dict properties:
- x
Numeric vector, representing the X coordinate for each vertex.
- y
Numeric vector, representing the Y coordinate for each vertex.
- z
Numeric vector, representing the Z coordinate for each vertex.
maxdisplayed¶The maximum number of displayed segments in a streamtube.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the surface. Please note that in the case
of using high opacity values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the webgl API. This behavior may be
improved in the near future and is subject to change.
An int or float in the interval [0, 1]
int|float
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)
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
sizeref¶The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.
An int or float in the interval [0, inf]
int|float
starts¶The ‘starts’ property is an instance of Starts that may be specified as:
An instance of
plotly.graph_objects.streamtube.StartsA dict of string/value properties that will be passed to the Starts constructor
Supported dict properties:
- x
Sets the x components of the starting position of the streamtubes
- xsrc
Sets the source reference on Chart Studio Cloud for
x.- y
Sets the y components of the starting position of the streamtubes
- ysrc
Sets the source reference on Chart Studio Cloud for
y.- z
Sets the z components of the starting position of the streamtubes
- zsrc
Sets the source reference on Chart Studio Cloud for
z.
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.streamtube.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets a text element associated with this trace. If trace
hoverinfo contains a “text” flag, this text element will be
seen in all hover labels. Note that streamtube traces do not
support array text values.
A string
A number that will be converted to a string
type¶u¶Sets the x components of the vector field.
The ‘u’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
uhoverformat¶Sets the hover text formatting rulefor u 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
usrc¶Sets the source reference on Chart Studio Cloud for u.
The ‘usrc’ property must be specified as a string or as a plotly.grid_objs.Column object
v¶Sets the y components of the vector field.
The ‘v’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
vhoverformat¶Sets the hover text formatting rulefor v 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
vsrc¶Sets the source reference on Chart Studio Cloud for v.
The ‘vsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
w¶Sets the z components of the vector field.
The ‘w’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
whoverformat¶Sets the hover text formatting rulefor w 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
wsrc¶Sets the source reference on Chart Studio Cloud for w.
The ‘wsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
x¶Sets the x coordinates of the vector field.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates of the vector field.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the z coordinates of the vector field.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Sunburst(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
branchvalues¶Determines how the items in values are summed. When set to
“total”, items in values are taken to be value of all its
descendants. When set to “remainder”, items in values
corresponding to the root and the branches sectors are taken to
be the extra part not part of the sum of the values at their
leaves.
[‘remainder’, ‘total’]
Any
count¶Determines default for values when it is not provided, by
inferring a 1 for each of the “leaves” and/or “branches”,
otherwise 0.
The ‘count’ property is a flaglist and may be specified as a string containing:
Any combination of [‘branches’, ‘leaves’] joined with ‘+’ characters (e.g. ‘branches+leaves’)
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.sunburst.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this sunburst trace .
- row
If there is a layout grid, use the domain for this row in the grid for this sunburst trace .
- x
Sets the horizontal domain of this sunburst trace (in plot fraction).
- y
Sets the vertical domain of this sunburst trace (in plot fraction).
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘name’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.sunburst.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables currentPath, root,
entry, percentRoot, percentEntry and percentParent.
Anything contained in tag <extra> is displayed in the
secondary box, for example “<extra>{fullData.name}</extra>”. To
hide the secondary box completely, use an empty tag
<extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each sector. If a
single string, the same string appears for all data points. If
an array of string, the items are mapped in order of this
trace’s sectors. To be seen, trace hoverinfo must contain a
“text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextfont¶Sets the font used for textinfo lying inside the sector.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.sunburst.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
insidetextorientation¶Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.
[‘horizontal’, ‘radial’, ‘tangential’, ‘auto’]
Any
labels¶Sets the labels of each of the sectors.
The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
labelssrc¶Sets the source reference on Chart Studio Cloud for labels.
The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
leaf¶The ‘leaf’ property is an instance of Leaf that may be specified as:
An instance of
plotly.graph_objects.sunburst.LeafA dict of string/value properties that will be passed to the Leaf constructor
Supported dict properties:
- opacity
Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.sunburst.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
level¶Sets the level from which this trace hierarchy is rendered. Set
level to '' to start from the root node in the hierarchy.
Must be an “id” if ids is filled in, otherwise plotly
attempts to find a matching item in labels.
The ‘level’ property accepts values of any type
Any
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.sunburst.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if colors is set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in
marker.cminandmarker.cmaxHas an effect only if colors is set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set,
marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set,
marker.cmaxmust be set as well.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.sunburst.marker.Co lorBarinstance or dict with compatible properties- colors
Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.
- colorscale
Sets the colorscale. Has an effect only if colors is set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorssrc
Sets the source reference on Chart Studio Cloud for
colors.- line
plotly.graph_objects.sunburst.marker.Li neinstance or dict with compatible properties- pattern
Sets the pattern within the marker.
- reversescale
Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true,
marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.
maxdepth¶Sets the number of rendered sectors from any given level. Set
maxdepth to “-1” to render all the levels in the hierarchy.
An int (or float that will be cast to an int)
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
outsidetextfont¶Sets the font used for textinfo lying outside the sector.
This option refers to the root of the hierarchy presented at
the center of a sunburst graph. Please note that if a hierarchy
has multiple root nodes, this option won’t have any effect and
insidetextfont would be used.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.sunburst.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
parents¶Sets the parent sectors for each of the sectors. Empty string
items ‘’ are understood to reference the root node in the
hierarchy. If ids is filled, parents items are understood
to be “ids” themselves. When ids is not set, plotly attempts
to find matching items in labels, but beware they must be
unique.
The ‘parents’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
parentssrc¶Sets the source reference on Chart Studio Cloud for parents.
The ‘parentssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
root¶The ‘root’ property is an instance of Root that may be specified as:
An instance of
plotly.graph_objects.sunburst.RootA dict of string/value properties that will be passed to the Root constructor
Supported dict properties:
- color
sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.
rotation¶Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o’clock.
The ‘rotation’ 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
sort¶Determines whether or not the sectors are reordered from largest to smallest.
The ‘sort’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.sunburst.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each sector. If trace
textinfo contains a “text” flag, these elements will be seen
on the chart. If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in the
hover labels.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶Sets the font used for textinfo.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.sunburst.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph.
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables
currentPath, root, entry, percentRoot, percentEntry,
percentParent, label and value.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
values¶Sets the values associated with each of the sectors. Use with
branchvalues to determine how the values are summed.
The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuessrc¶Sets the source reference on Chart Studio Cloud for values.
The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Surface(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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 z or surfacecolor) 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 z or surfacecolor 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 z or surfacecolor. 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 z or surfacecolor and if set, cmax must be set
as well.
An int or float
int|float
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.surface.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.surface .colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.surface.colorbar.tickformatstopdefaults), sets the default property values to use for elements of surface.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.surface.colorbar.T itleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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.
connectgaps¶Determines whether or not gaps (i.e. {nan} or missing values)
in the z data are filled in.
The ‘connectgaps’ property must be specified as a bool (either True, or False)
contours¶The ‘contours’ property is an instance of Contours that may be specified as:
An instance of
plotly.graph_objects.surface.ContoursA dict of string/value properties that will be passed to the Contours constructor
Supported dict properties:
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hidesurface¶Determines whether or not a surface is drawn. For example, set
hidesurface to False contours.x.show to True and
contours.y.show to True to draw a wire frame plot.
The ‘hidesurface’ property must be specified as a bool (either True, or False)
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.surface.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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 trace. 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.surface.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lighting¶The ‘lighting’ property is an instance of Lighting that may be specified as:
An instance of
plotly.graph_objects.surface.LightingA dict of string/value properties that will be passed to the Lighting constructor
Supported dict properties:
- ambient
Ambient light increases overall color visibility but can wash out the image.
- diffuse
Represents the extent that incident rays are reflected in a range of angles.
- fresnel
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Represents the level that incident rays are reflected in a single direction, causing shine.
lightposition¶The ‘lightposition’ property is an instance of Lightposition that may be specified as:
An instance of
plotly.graph_objects.surface.LightpositionA dict of string/value properties that will be passed to the Lightposition constructor
Supported dict properties:
- x
Numeric vector, representing the X coordinate for each vertex.
- y
Numeric vector, representing the Y coordinate for each vertex.
- z
Numeric vector, representing the Z coordinate for each vertex.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the surface. Please note that in the case
of using high opacity values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the webgl API. This behavior may be
improved in the near future and is subject to change.
An int or float in the interval [0, 1]
int|float
opacityscale¶Sets the opacityscale. The opacityscale must be an array
containing arrays mapping a normalized value to an opacity
value. At minimum, a mapping for the lowest (0) and highest (1)
values are required. For example, [[0, 1], [0.5, 0.2], [1,
1]] means that higher/lower values would have higher opacity
values and those in the middle would be more transparent
Alternatively, opacityscale may be a palette name string of
the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The
default is ‘uniform’.
The ‘opacityscale’ property accepts values of any type
Any
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)
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.surface.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
surfacecolor¶Sets the surface color values, used for setting a color scale
independent of z.
The ‘surfacecolor’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
surfacecolorsrc¶Sets the source reference on Chart Studio Cloud for
surfacecolor.
The ‘surfacecolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
text¶Sets the text elements associated with each z value. If trace
hoverinfo contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xcalendar¶Sets the calendar system to use with x date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
ycalendar¶Sets the calendar system to use with y date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the z coordinates.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zcalendar¶Sets the calendar system to use with z date data.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Table(arg=None, cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
cells¶The ‘cells’ property is an instance of Cells that may be specified as:
An instance of
plotly.graph_objects.table.CellsA dict of string/value properties that will be passed to the Cells constructor
Supported dict properties:
- align
Sets the horizontal alignment of the
textwithin the box. Has an effect only iftextspans two or more lines (i.e.textcontains one or more <br> HTML tags) or if an explicit width is set to override the text width.- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- fill
plotly.graph_objects.table.cells.Fillinstance or dict with compatible properties- font
plotly.graph_objects.table.cells.Fontinstance or dict with compatible properties- format
Sets the cell value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
- formatsrc
Sets the source reference on Chart Studio Cloud for
format.- height
The height of cells.
- line
plotly.graph_objects.table.cells.Lineinstance or dict with compatible properties- prefix
Prefix for cell values.
- prefixsrc
Sets the source reference on Chart Studio Cloud for
prefix.- suffix
Suffix for cell values.
- suffixsrc
Sets the source reference on Chart Studio Cloud for
suffix.- values
Cell values.
values[m][n]represents the value of then`th point in column `m, therefore thevalues[m]vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.- valuessrc
Sets the source reference on Chart Studio Cloud for
values.
columnorder¶Specifies the rendered order of the data columns; for example,
a value 2 at position 0 means that column index 0 in the
data will be rendered as the third column, as columns have an
index base of zero.
The ‘columnorder’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
columnordersrc¶Sets the source reference on Chart Studio Cloud for
columnorder.
The ‘columnordersrc’ property must be specified as a string or as a plotly.grid_objs.Column object
columnwidth¶The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
An int or float
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
columnwidthsrc¶Sets the source reference on Chart Studio Cloud for
columnwidth.
The ‘columnwidthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.table.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this table trace .
- row
If there is a layout grid, use the domain for this row in the grid for this table trace .
- x
Sets the horizontal domain of this table trace (in plot fraction).
- y
Sets the vertical domain of this table trace (in plot fraction).
header¶The ‘header’ property is an instance of Header that may be specified as:
An instance of
plotly.graph_objects.table.HeaderA dict of string/value properties that will be passed to the Header constructor
Supported dict properties:
- align
Sets the horizontal alignment of the
textwithin the box. Has an effect only iftextspans two or more lines (i.e.textcontains one or more <br> HTML tags) or if an explicit width is set to override the text width.- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- fill
plotly.graph_objects.table.header.Fillinstance or dict with compatible properties- font
plotly.graph_objects.table.header.Fontinstance or dict with compatible properties- format
Sets the cell value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format.
- formatsrc
Sets the source reference on Chart Studio Cloud for
format.- height
The height of cells.
- line
plotly.graph_objects.table.header.Lineinstance or dict with compatible properties- prefix
Prefix for cell values.
- prefixsrc
Sets the source reference on Chart Studio Cloud for
prefix.- suffix
Suffix for cell values.
- suffixsrc
Sets the source reference on Chart Studio Cloud for
suffix.- values
Header cell values.
values[m][n]represents the value of then`th point in column `m, therefore thevalues[m]vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.- valuessrc
Sets the source reference on Chart Studio Cloud for
values.
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.table.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.table.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.table.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Trace(*args, **kwargs)¶Bases: dict
plotly.graph_objects.Trace is deprecated.
plotly.graph_objects.Scatter
plotly.graph_objects.Bar
plotly.graph_objects.Area
plotly.graph_objects.Histogram
etc.
plotly.graph_objects.Treemap(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
branchvalues¶Determines how the items in values are summed. When set to
“total”, items in values are taken to be value of all its
descendants. When set to “remainder”, items in values
corresponding to the root and the branches sectors are taken to
be the extra part not part of the sum of the values at their
leaves.
[‘remainder’, ‘total’]
Any
count¶Determines default for values when it is not provided, by
inferring a 1 for each of the “leaves” and/or “branches”,
otherwise 0.
The ‘count’ property is a flaglist and may be specified as a string containing:
Any combination of [‘branches’, ‘leaves’] joined with ‘+’ characters (e.g. ‘branches+leaves’)
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
domain¶The ‘domain’ property is an instance of Domain that may be specified as:
An instance of
plotly.graph_objects.treemap.DomainA dict of string/value properties that will be passed to the Domain constructor
Supported dict properties:
- column
If there is a layout grid, use the domain for this column in the grid for this treemap trace .
- row
If there is a layout grid, use the domain for this row in the grid for this treemap trace .
- x
Sets the horizontal domain of this treemap trace (in plot fraction).
- y
Sets the vertical domain of this treemap trace (in plot fraction).
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘name’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.treemap.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables currentPath, root,
entry, percentRoot, percentEntry and percentParent.
Anything contained in tag <extra> is displayed in the
secondary box, for example “<extra>{fullData.name}</extra>”. To
hide the secondary box completely, use an empty tag
<extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each sector. If a
single string, the same string appears for all data points. If
an array of string, the items are mapped in order of this
trace’s sectors. To be seen, trace hoverinfo must contain a
“text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
insidetextfont¶Sets the font used for textinfo lying inside the sector.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.treemap.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
labels¶Sets the labels of each of the sectors.
The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
labelssrc¶Sets the source reference on Chart Studio Cloud for labels.
The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
legend¶Sets the reference to a legend to show this trace 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.)
legendgrouptitle¶The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:
An instance of
plotly.graph_objects.treemap.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
level¶Sets the level from which this trace hierarchy is rendered. Set
level to '' to start from the root node in the hierarchy.
Must be an “id” if ids is filled in, otherwise plotly
attempts to find a matching item in labels.
The ‘level’ property accepts values of any type
Any
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.treemap.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bymarker.colorscale. Has an effect only if colors is set to a numerical array. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.- cauto
Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in
marker.cminandmarker.cmaxHas an effect only if colors is set to a numerical array. Defaults tofalsewhenmarker.cminandmarker.cmaxare set by the user.- cmax
Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set,
marker.cminmust be set as well.- cmid
Sets the mid-point of the color domain by scaling
marker.cminand/ormarker.cmaxto be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect whenmarker.cautoisfalse.- cmin
Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set,
marker.cmaxmust be set as well.- coloraxis
Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under
layout.coloraxis,layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.- colorbar
plotly.graph_objects.treemap.marker.Col orBarinstance or dict with compatible properties- colors
Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.
- colorscale
Sets the colorscale. Has an effect only if colors is set to a numerical array. 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, usemarker.cminandmarker.cmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd Bu,Reds,Viridis,YlGnBu,YlOrRd.- colorssrc
Sets the source reference on Chart Studio Cloud for
colors.- cornerradius
Sets the maximum rounding of corners (in px).
- depthfade
Determines if the sector colors are faded towards the background from the leaves up to the headers. This option is unavailable when a
colorscaleis present, defaults to false whenmarker.colorsis set, but otherwise defaults to true. When set to “reversed”, the fading direction is inverted, that is the top elements within hierarchy are drawn with fully saturated colors while the leaves are faded towards the background color.- line
plotly.graph_objects.treemap.marker.Lin einstance or dict with compatible properties- pad
:class:`plotly.graph_objects.treemap.marker.Pad ` instance or dict with compatible properties
- pattern
Sets the pattern within the marker.
- reversescale
Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true,
marker.cminwill correspond to the last color in the array andmarker.cmaxwill correspond to the first color.- showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.
maxdepth¶Sets the number of rendered sectors from any given level. Set
maxdepth to “-1” to render all the levels in the hierarchy.
An int (or float that will be cast to an int)
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
outsidetextfont¶Sets the font used for textinfo lying outside the sector.
This option refers to the root of the hierarchy presented on
top left corner of a treemap graph. Please note that if a
hierarchy has multiple root nodes, this option won’t have any
effect and insidetextfont would be used.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.treemap.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
parents¶Sets the parent sectors for each of the sectors. Empty string
items ‘’ are understood to reference the root node in the
hierarchy. If ids is filled, parents items are understood
to be “ids” themselves. When ids is not set, plotly attempts
to find matching items in labels, but beware they must be
unique.
The ‘parents’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
parentssrc¶Sets the source reference on Chart Studio Cloud for parents.
The ‘parentssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
pathbar¶The ‘pathbar’ property is an instance of Pathbar that may be specified as:
An instance of
plotly.graph_objects.treemap.PathbarA dict of string/value properties that will be passed to the Pathbar constructor
Supported dict properties:
- edgeshape
Determines which shape is used for edges between
barpathlabels.- side
Determines on which side of the the treemap the
pathbarshould be presented.- textfont
Sets the font used inside
pathbar.- thickness
Sets the thickness of
pathbar(in px). If not specified thepathbar.textfont.sizeis used with 3 pixles extra padding on each side.- visible
Determines if the path bar is drawn i.e. outside the trace
domainand with one pixel gap.
root¶The ‘root’ property is an instance of Root that may be specified as:
An instance of
plotly.graph_objects.treemap.RootA dict of string/value properties that will be passed to the Root constructor
Supported dict properties:
- color
sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.
sort¶Determines whether or not the sectors are reordered from largest to smallest.
The ‘sort’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.treemap.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each sector. If trace
textinfo contains a “text” flag, these elements will be seen
on the chart. If trace hoverinfo contains a “text” flag and
“hovertext” is not set, these elements will be seen in the
hover labels.
The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
textfont¶Sets the font used for textinfo.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.treemap.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph.
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘value’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textposition¶Sets the positions of the text elements.
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
Any
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables
currentPath, root, entry, percentRoot, percentEntry,
percentParent, label and value.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tiling¶The ‘tiling’ property is an instance of Tiling that may be specified as:
An instance of
plotly.graph_objects.treemap.TilingA dict of string/value properties that will be passed to the Tiling constructor
Supported dict properties:
- flip
Determines if the positions obtained from solver are flipped on each axis.
- packing
Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap- tiling
- pad
Sets the inner padding (in px).
- squarifyratio
When using “squarify”
packingalgorithm, according to https://github.com/d3/d3- hierarchy/blob/v3.1.1/README.md#squarify_ratio this option specifies the desired aspect ratio of the generated rectangles. The ratio must be specified as a number greater than or equal to one. Note that the orientation of the generated rectangles (tall or wide) is not implied by the ratio; for example, a ratio of two will attempt to produce a mixture of rectangles whose width:height ratio is either 2:1 or 1:2. When using “squarify”, unlike d3 which uses the Golden Ratio i.e. 1.618034, Plotly applies 1 to increase squares in treemap layouts.
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
values¶Sets the values associated with each of the sectors. Use with
branchvalues to determine how the values are summed.
The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuessrc¶Sets the source reference on Chart Studio Cloud for values.
The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
plotly.graph_objects.Violin(arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
bandwidth¶Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman’s rule of thumb.
An int or float in the interval [0, inf]
int|float
box¶The ‘box’ property is an instance of Box that may be specified as:
An instance of
plotly.graph_objects.violin.BoxA dict of string/value properties that will be passed to the Box constructor
Supported dict properties:
- fillcolor
Sets the inner box plot fill color.
- line
plotly.graph_objects.violin.box.Lineinstance or dict with compatible properties- visible
Determines if an miniature box plot is drawn inside the violins.
- width
Sets the width of the inner box plots relative to the violins’ width. For example, with 1, the inner box plots are as wide as the violins.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
fillcolor¶Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.violin.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hoveron¶Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?
The ‘hoveron’ property is a flaglist and may be specified as a string containing:
Any combination of [‘violins’, ‘points’, ‘kde’] joined with ‘+’ characters (e.g. ‘violins+points’) OR exactly one of [‘all’] (e.g. ‘all’)
Any
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
jitter¶Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins.
An int or float in the interval [0, 1]
int|float
legend¶Sets the reference to a legend to show this trace 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 trace. 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.violin.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
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.violin.LineA dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the color of line bounding the violin(s).
- width
Sets the width (in px) of line bounding the violin(s).
marker¶The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.violin.MarkerA dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- angle
Sets the marker angle in respect to
angleref.- color
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to
marker.cminandmarker.cmaxif set.- line
:class:`plotly.graph_objects.violin.marker.Line ` instance or dict with compatible properties
- opacity
Sets the marker opacity.
- outliercolor
Sets the color of the outlier sample points.
- size
Sets the marker size (in px).
- symbol
Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot- open” to a symbol name.
meanline¶The ‘meanline’ property is an instance of Meanline that may be specified as:
An instance of
plotly.graph_objects.violin.MeanlineA dict of string/value properties that will be passed to the Meanline constructor
Supported dict properties:
- color
Sets the mean line color.
- visible
Determines if a line corresponding to the sample’s mean is shown inside the violins. If
box.visibleis turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.- width
Sets the mean line width.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item
and on hover. For violin traces, the name will also be used for
the position coordinate, if x and x0 (y and y0 if
horizontal) are missing and the position axis is categorical.
Note that the trace name is also used as a default value for
attribute scalegroup (please see its description for
details).
A string
A number that will be converted to a string
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶Sets the orientation of the violin(s). If “v” (“h”), the distribution is visualized along the vertical (horizontal).
[‘v’, ‘h’]
Any
pointpos¶Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.
An int or float in the interval [-2, 2]
int|float
points¶If “outliers”, only the sample points lying outside the
whiskers are shown If “suspectedoutliers”, the outlier points
are shown and points either less than 4*Q1-3*Q3 or greater than
4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all
sample points are shown If False, only the violins are shown
with no sample points. Defaults to “suspectedoutliers” when
marker.outliercolor or marker.line.outliercolor is set,
otherwise defaults to “outliers”.
[‘all’, ‘outliers’, ‘suspectedoutliers’, False]
Any
quartilemethod¶Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
[‘linear’, ‘exclusive’, ‘inclusive’]
Any
scalegroup¶If there are multiple violins that should be sized according to
to some metric (see scalemode), link them by providing a non-
empty group id here shared by every trace in the same group. If
a violin’s width is undefined, scalegroup will default to
the trace’s name. In this case, violins with the same names
will be linked together
A string
A number that will be converted to a string
scalemode¶Sets the metric by which the width of each violin is determined. “width” means each violin has the same (max) width “count” means the violins are scaled by the number of sample points making up each violin.
[‘width’, ‘count’]
Any
selected¶The ‘selected’ property is an instance of Selected that may be specified as:
An instance of
plotly.graph_objects.violin.SelectedA dict of string/value properties that will be passed to the Selected constructor
Supported dict properties:
- marker
plotly.graph_objects.violin.selected.Ma rkerinstance or dict with compatible properties
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
side¶Determines on which side of the position value the density
function making up one half of a violin is plotted. Useful when
comparing two violin traces under “overlay” mode, where one
trace has side set to “positive” and the other to “negative”.
[‘both’, ‘positive’, ‘negative’]
Any
span¶be computed. Has an effect only when spanmode is set to
“manual”.
The ‘span’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
The ‘span[0]’ property accepts values of any type
The ‘span[1]’ property accepts values of any type
list
spanmode¶Sets the method by which the span in data space where the
density function will be computed. “soft” means the span goes
from the sample’s minimum value minus two bandwidths to the
sample’s maximum value plus two bandwidths. “hard” means the
span goes from the sample’s minimum to its maximum value. For
custom span settings, use mode “manual” and fill in the span
attribute.
[‘soft’, ‘hard’, ‘manual’]
Any
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.violin.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets the text elements associated with each sample value. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
unselected¶The ‘unselected’ property is an instance of Unselected that may be specified as:
An instance of
plotly.graph_objects.violin.UnselectedA dict of string/value properties that will be passed to the Unselected constructor
Supported dict properties:
- marker
plotly.graph_objects.violin.unselected. Markerinstance or dict with compatible properties
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
width¶Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.
An int or float in the interval [0, inf]
int|float
x¶Sets the x sample data or coordinates. See overview for more info.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y sample data or coordinates. See overview for more info.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.Volume(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
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)
caps¶The ‘caps’ property is an instance of Caps that may be specified as:
An instance of
plotly.graph_objects.volume.CapsA dict of string/value properties that will be passed to the Caps constructor
Supported dict properties:
- x
plotly.graph_objects.volume.caps.Xinstance or dict with compatible properties- y
plotly.graph_objects.volume.caps.Yinstance or dict with compatible properties- z
plotly.graph_objects.volume.caps.Zinstance or dict with compatible properties
cauto¶Determines whether or not the color domain is computed with
respect to the input data (here value) 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 value 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 value. 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 value and if set, cmax must be set as well.
An int or float
int|float
coloraxis¶Sets a reference to a shared color axis. References to these
shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”,
etc. Settings for these shared color axes are set in the
layout, under layout.coloraxis, layout.coloraxis2, etc.
Note that multiple color scales can be linked to the same color
axis.
The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
colorbar¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.volume.ColorBarA dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- 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 axistypeis “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>”, wherefis a positive number, gives ticks linearly spaced in value (but not position). For exampletick0= 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).tick0is ignored for “D1” and “D2”. If the axistypeis “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtickto 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.nmust be a positive integer. To set ticks on the 15th of every third month, settick0to “2000-01-15” anddtickto “M3”. To set ticks every 4 years, setdtickto “M48”- 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.
- 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.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
lento set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformatis “SI” or “B”.- 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 iftickmodeis set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- 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.
- showticklabels
Determines whether or not the tick labels are drawn.
- 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.
- showticksuffix
Same as
showtickprefixbut for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thicknessto set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick. If the axistypeis “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0to 2) except whendtick`=*L<f>* (see `dtickfor more info). If the axistypeis “date”, it should be a date string, like date data. If the axistypeis “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangleof -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.volume. colorbar.Tickformatstopinstances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.volume.colorbar.tickformatstopdefaults), sets the default property values to use for elements of volume.colorbar.tickformatstops
- 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. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientationis “h”, top and bottom whenorientationis “v”.- 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.
tick0determines which labels are shown. Not implemented for axes withtype“log” or “multicategory”, or whentickmodeis “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks. If “linear”, the placement of the ticks is determined by a starting positiontick0and a tick stepdtick(“linear” is the default value iftick0anddtickare provided). If “array”, the placement of the ticks is set viatickvalsand the tick text isticktext. (“array” is the default value iftickvalsis provided).- tickprefix
Sets a tick label prefix.
- 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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals. Only has an effect iftickmodeis set to “array”. Used withtickvals.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmodeis set to “array”. Used withticktext.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.volume.colorbar.Ti tleinstance or dict with compatible properties- x
Sets the x position with respect to
xrefof the color bar (in plot fraction). Whenxrefis “paper”, defaults to 1.02 whenorientationis “v” and 0.5 whenorientationis “h”. Whenxrefis “container”, defaults to 1 whenorientationis “v” and 0.5 whenorientationis “h”. Must be between 0 and 1 ifxrefis “container” and between “-2” and 3 ifxrefis “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
xposition to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientationis “v” and “center” whenorientationis “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
xrefers to. “container” spans the entirewidthof the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yrefof the color bar (in plot fraction). Whenyrefis “paper”, defaults to 0.5 whenorientationis “v” and 1.02 whenorientationis “h”. Whenyrefis “container”, defaults to 0.5 whenorientationis “v” and 1 whenorientationis “h”. Must be between 0 and 1 ifyrefis “container” and between “-2” and 3 ifyrefis “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
yposition to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientationis “v” and “bottom” whenorientationis “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
yrefers to. “container” spans the entireheightof the plot. “paper” refers to the height of the plotting area only.
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.
contour¶The ‘contour’ property is an instance of Contour that may be specified as:
An instance of
plotly.graph_objects.volume.ContourA dict of string/value properties that will be passed to the Contour constructor
Supported dict properties:
- color
Sets the color of the contour lines.
- show
Sets whether or not dynamic contours are shown on hover
- width
Sets the width of the contour lines.
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
flatshading¶Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
The ‘flatshading’ property must be specified as a bool (either True, or False)
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.volume.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Anything
contained in tag <extra> is displayed in the secondary box,
for example “<extra>{fullData.name}</extra>”. To hide the
secondary box completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Same as text.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
isomax¶Sets the maximum boundary for iso-surface plot.
An int or float
int|float
isomin¶Sets the minimum boundary for iso-surface plot.
An int or float
int|float
legend¶Sets the reference to a legend to show this trace 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 trace. 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.volume.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
lighting¶The ‘lighting’ property is an instance of Lighting that may be specified as:
An instance of
plotly.graph_objects.volume.LightingA dict of string/value properties that will be passed to the Lighting constructor
Supported dict properties:
- ambient
Ambient light increases overall color visibility but can wash out the image.
- diffuse
Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
lightposition¶The ‘lightposition’ property is an instance of Lightposition that may be specified as:
An instance of
plotly.graph_objects.volume.LightpositionA dict of string/value properties that will be passed to the Lightposition constructor
Supported dict properties:
- x
Numeric vector, representing the X coordinate for each vertex.
- y
Numeric vector, representing the Y coordinate for each vertex.
- z
Numeric vector, representing the Z coordinate for each vertex.
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
opacity¶Sets the opacity of the surface. Please note that in the case
of using high opacity values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the webgl API. This behavior may be
improved in the near future and is subject to change.
An int or float in the interval [0, 1]
int|float
opacityscale¶Sets the opacityscale. The opacityscale must be an array
containing arrays mapping a normalized value to an opacity
value. At minimum, a mapping for the lowest (0) and highest (1)
values are required. For example, [[0, 1], [0.5, 0.2], [1,
1]] means that higher/lower values would have higher opacity
values and those in the middle would be more transparent
Alternatively, opacityscale may be a palette name string of
the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The
default is ‘uniform’.
The ‘opacityscale’ property accepts values of any type
Any
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)
scene¶Sets a reference between this trace’s 3D coordinate system and
a 3D scene. If “scene” (the default value), the (x,y,z)
coordinates refer to layout.scene. If “scene2”, the (x,y,z)
coordinates refer to layout.scene2, and so on.
The ‘scene’ property is an identifier of a particular subplot, of type ‘scene’, that may be specified as the string ‘scene’ optionally followed by an integer >= 1 (e.g. ‘scene’, ‘scene1’, ‘scene2’, ‘scene3’, etc.)
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
showscale¶Determines whether or not a colorbar is displayed for this trace.
The ‘showscale’ property must be specified as a bool (either True, or False)
slices¶The ‘slices’ property is an instance of Slices that may be specified as:
An instance of
plotly.graph_objects.volume.SlicesA dict of string/value properties that will be passed to the Slices constructor
Supported dict properties:
- x
plotly.graph_objects.volume.slices.Xinstance or dict with compatible properties- y
plotly.graph_objects.volume.slices.Yinstance or dict with compatible properties- z
plotly.graph_objects.volume.slices.Zinstance or dict with compatible properties
spaceframe¶The ‘spaceframe’ property is an instance of Spaceframe that may be specified as:
An instance of
plotly.graph_objects.volume.SpaceframeA dict of string/value properties that will be passed to the Spaceframe constructor
Supported dict properties:
- fill
Sets the fill ratio of the
spaceframeelements. The default fill value is 1 meaning that they are entirely shaded. Applying afillratio less than one would allow the creation of openings parallel to the edges.- show
Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.volume.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
surface¶The ‘surface’ property is an instance of Surface that may be specified as:
An instance of
plotly.graph_objects.volume.SurfaceA dict of string/value properties that will be passed to the Surface constructor
Supported dict properties:
- count
Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
- fill
Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a
fillratio less than one would allow the creation of openings parallel to the edges.- pattern
Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is
allmeaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capitalA,B,C,DandEmay also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.- show
Hides/displays surfaces between minimum and maximum iso-values.
text¶Sets the text elements associated with the vertices. If trace
hoverinfo contains a “text” flag and “hovertext” is not set,
these elements will be seen in the hover labels.
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
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
value¶Sets the 4th dimension (value) of the vertices.
The ‘value’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
valuehoverformat¶Sets the hover text formatting rulefor value 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.By
default the values are formatted using generic number format.
A string
A number that will be converted to a string
valuesrc¶Sets the source reference on Chart Studio Cloud for value.
The ‘valuesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
x¶Sets the X coordinates of the vertices on X axis.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the Y coordinates of the vertices on Y axis.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
z¶Sets the Z coordinates of the vertices on Z axis.
The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
zhoverformat¶Sets the hover text formatting rulefor z 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*By default the values
are formatted using zaxis.hoverformat.
A string
A number that will be converted to a string
plotly.graph_objects.Waterfall(arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceType
alignmentgroup¶Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
A string
A number that will be converted to a string
base¶Sets where the bar base is drawn (in position axis units).
An int or float
int|float
cliponaxis¶Determines whether the text nodes are clipped about the subplot
axes. To show the text nodes above axis lines and tick labels,
make sure to set xaxis.layer and yaxis.layer to below
traces.
The ‘cliponaxis’ property must be specified as a bool (either True, or False)
connector¶The ‘connector’ property is an instance of Connector that may be specified as:
An instance of
plotly.graph_objects.waterfall.ConnectorA dict of string/value properties that will be passed to the Connector constructor
Supported dict properties:
- line
plotly.graph_objects.waterfall.connecto r.Lineinstance or dict with compatible properties- mode
Sets the shape of connector lines.
- visible
Determines if connector lines are drawn.
constraintext¶Constrain the size of text inside or outside a bar to be no larger than the bar itself.
[‘inside’, ‘outside’, ‘both’, ‘none’]
Any
customdata¶Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
The ‘customdata’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
customdatasrc¶Sets the source reference on Chart Studio Cloud for
customdata.
The ‘customdatasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
decreasing¶The ‘decreasing’ property is an instance of Decreasing that may be specified as:
An instance of
plotly.graph_objects.waterfall.DecreasingA dict of string/value properties that will be passed to the Decreasing constructor
Supported dict properties:
- marker
plotly.graph_objects.waterfall.decreasi ng.Markerinstance or dict with compatible properties
dx¶Sets the x coordinate step. See x0 for more info.
An int or float
int|float
dy¶Sets the y coordinate step. See y0 for more info.
An int or float
int|float
hoverinfo¶Determines which trace information appear on hover. If none
or skip are set, no information is displayed upon hovering.
But, if none is set, click and hover events are still fired.
The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘name’, ‘x’, ‘y’, ‘text’, ‘initial’, ‘delta’, ‘final’] joined with ‘+’ characters (e.g. ‘name+x’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
A list or array of the above
Any|numpy.ndarray
hoverinfosrc¶Sets the source reference on Chart Studio Cloud for
hoverinfo.
The ‘hoverinfosrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hoverlabel¶The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
An instance of
plotly.graph_objects.waterfall.HoverlabelA dict of string/value properties that will be passed to the Hoverlabel constructor
Supported dict properties:
- 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
- alignsrc
Sets the source reference on Chart Studio Cloud for
align.- bgcolor
Sets the background color of the hover labels for this trace
- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor.- bordercolor
Sets the border color of the hover labels for this trace.
- bordercolorsrc
Sets the source reference on Chart Studio Cloud for
bordercolor.- font
Sets the font used in hover labels.
- 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 - 3characters and add an ellipsis.- namelengthsrc
Sets the source reference on Chart Studio Cloud for
namelength.
hovertemplate¶Template string used for rendering the information that appear
on hover box. Note that this will override hoverinfo.
Variables are inserted using %{variable}, for example “y: %{y}”
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
showing info for several points, “xother” will be added to
those with different x positions from the first point. An
underscore before or after “(x|y)other” will add a space on
that side, only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. The variables available in hovertemplate
are the ones emitted as event data described at this link
https://plotly.com/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified per-point
(the ones that are arrayOk: true) are available. Finally, the
template string has access to variables initial, delta and
final. Anything contained in tag <extra> is displayed in
the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary box
completely, use an empty tag <extra></extra>.
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
hovertemplatesrc¶Sets the source reference on Chart Studio Cloud for
hovertemplate.
The ‘hovertemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hovertext¶Sets hover text elements associated with each (x,y) pair. If a
single string, the same string appears over all the data
points. If an array of string, the items are mapped in order to
the this trace’s (x,y) coordinates. To be seen, trace
hoverinfo must contain a “text” flag.
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
hovertextsrc¶Sets the source reference on Chart Studio Cloud for
hovertext.
The ‘hovertextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
ids¶Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
The ‘ids’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
idssrc¶Sets the source reference on Chart Studio Cloud for ids.
The ‘idssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
increasing¶The ‘increasing’ property is an instance of Increasing that may be specified as:
An instance of
plotly.graph_objects.waterfall.IncreasingA dict of string/value properties that will be passed to the Increasing constructor
Supported dict properties:
- marker
plotly.graph_objects.waterfall.increasi ng.Markerinstance or dict with compatible properties
insidetextanchor¶Determines if texts are kept at center or start/end points in
textposition “inside” mode.
[‘end’, ‘middle’, ‘start’]
Any
insidetextfont¶Sets the font used for text lying inside the bar.
The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:
An instance of
plotly.graph_objects.waterfall.InsidetextfontA dict of string/value properties that will be passed to the Insidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
legend¶Sets the reference to a legend to show this trace 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 trace. 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.waterfall.LegendgrouptitleA dict of string/value properties that will be passed to the Legendgrouptitle constructor
Supported dict properties:
- font
Sets this legend group’s title font.
- text
Sets the title of the legend group.
legendrank¶Sets the legend rank for this trace. 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 trace.
An int or float in the interval [0, inf]
int|float
measure¶An array containing types of values. By default the values are considered as ‘relative’. However; it is possible to use ‘total’ to compute the sums. Also ‘absolute’ could be applied to reset the computed total or to declare an initial value where needed.
The ‘measure’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
measuresrc¶Sets the source reference on Chart Studio Cloud for measure.
The ‘measuresrc’ property must be specified as a string or as a plotly.grid_objs.Column object
meta¶Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace name, graph, axis and colorbar title.text, annotation
text rangeselector, updatemenues and sliders label
text all support meta. To access the trace meta values in
an attribute in the same trace, simply use %{meta[i]} where
i is the index or key of the meta item in question. To
access trace meta in layout attributes, use
%{data[n[.meta[i]} where i is the index or key of the
meta and n is the trace index.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
name¶Sets the trace name. The trace name appears as the legend item and on hover.
A string
A number that will be converted to a string
offset¶Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.
An int or float
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
offsetgroup¶Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
A string
A number that will be converted to a string
offsetsrc¶Sets the source reference on Chart Studio Cloud for offset.
The ‘offsetsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
opacity¶Sets the opacity of the trace.
An int or float in the interval [0, 1]
int|float
orientation¶Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).
[‘v’, ‘h’]
Any
outsidetextfont¶Sets the font used for text lying outside the bar.
The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:
An instance of
plotly.graph_objects.waterfall.OutsidetextfontA dict of string/value properties that will be passed to the Outsidetextfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
selectedpoints¶Array containing integer indices of selected points. Has an
effect only for traces that support selections. Note that an
empty array means an empty selection where the unselected are
turned on for all points, whereas, any other non-array values
means no selection all where the selected and unselected
styles have no effect.
The ‘selectedpoints’ property accepts values of any type
Any
showlegend¶Determines whether or not an item corresponding to this trace is shown in the legend.
The ‘showlegend’ property must be specified as a bool (either True, or False)
stream¶The ‘stream’ property is an instance of Stream that may be specified as:
An instance of
plotly.graph_objects.waterfall.StreamA dict of string/value properties that will be passed to the Stream constructor
Supported dict properties:
- maxpoints
Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpointsis set to 50, only the newest 50 points will be displayed on the plot.- token
The stream id number links a data trace on a plot with a stream. See https://chart- studio.plotly.com/settings for more details.
text¶Sets text elements associated with each (x,y) pair. If a single
string, the same string appears over all the data points. If an
array of string, the items are mapped in order to the this
trace’s (x,y) coordinates. If trace hoverinfo contains a
“text” flag and “hovertext” is not set, these elements will be
seen in the hover labels.
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
textangle¶Sets the angle of the tick labels with respect to the bar. For
example, a tickangle of -90 draws the tick labels vertically.
With “auto” the texts may automatically be rotated to fit with
the maximum size in bars.
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
textfont¶Sets the font used for text.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.waterfall.TextfontA dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight.
textinfo¶Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).
The ‘textinfo’ property is a flaglist and may be specified as a string containing:
Any combination of [‘label’, ‘text’, ‘initial’, ‘delta’, ‘final’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
textposition¶Specifies the location of the text. “inside” positions text
inside, next to the bar end (rotated and scaled if needed).
“outside” positions text outside, next to the bar end (scaled
if needed), unless there is another bar stacked on this one,
then the text gets pushed inside. “auto” tries to position
text inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If “none”, no
text appears.
[‘inside’, ‘outside’, ‘auto’, ‘none’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
textpositionsrc¶Sets the source reference on Chart Studio Cloud for
textposition.
The ‘textpositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
textsrc¶Sets the source reference on Chart Studio Cloud for text.
The ‘textsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
texttemplate¶Template string used for rendering the information text that
appear on points. Note that this will override textinfo.
Variables are inserted using %{variable}, for example “y:
%{y}”. Numbers are formatted using d3-format’s syntax
%{variable:d3-format}, for example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
details on the formatting syntax. Dates are formatted using
d3-time-format’s syntax %{variable|d3-time-format}, for example
“Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the date
formatting syntax. Every attributes that can be specified per-
point (the ones that are arrayOk: true) are available.
Finally, the template string has access to variables initial,
delta, final and label.
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
texttemplatesrc¶Sets the source reference on Chart Studio Cloud for
texttemplate.
The ‘texttemplatesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
totals¶The ‘totals’ property is an instance of Totals that may be specified as:
An instance of
plotly.graph_objects.waterfall.TotalsA dict of string/value properties that will be passed to the Totals constructor
Supported dict properties:
- marker
plotly.graph_objects.waterfall.totals.M arkerinstance or dict with compatible properties
type¶uid¶Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
A string
A number that will be converted to a string
uirevision¶Controls persistence of some user-driven changes to the trace:
constraintrange in parcoords traces, as well as some
editable: true modifications such as name and
colorbar.title. Defaults to layout.uirevision. Note that
other user-driven trace attribute changes are controlled by
layout attributes: trace.visible is controlled by
layout.legend.uirevision, selectedpoints is controlled by
layout.selectionrevision, and colorbar.(x|y) (accessible
with config: {editable: true}) is controlled by
layout.editrevision. Trace changes are tracked by uid,
which only falls back on trace index if no uid is provided.
So if your app can add/remove traces before the end of the
data array, such that the same trace has a different index,
you can still preserve user-driven changes if you give each
trace a uid that stays with it as it moves.
The ‘uirevision’ property accepts values of any type
Any
visible¶Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
[True, False, ‘legendonly’]
Any
width¶Sets the bar width (in position axis units).
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
widthsrc¶Sets the source reference on Chart Studio Cloud for width.
The ‘widthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
x¶Sets the x coordinates.
The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
x0¶Alternate to x. Builds a linear space of x coordinates. Use
with dx where x0 is the starting coordinate and dx the
step.
The ‘x0’ property accepts values of any type
Any
xaxis¶Sets a reference between this trace’s x coordinates and a 2D
cartesian x axis. If “x” (the default value), the x coordinates
refer to layout.xaxis. If “x2”, the x coordinates refer to
layout.xaxis2, and so on.
The ‘xaxis’ property is an identifier of a particular subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)
xhoverformat¶Sets the hover text formatting rulefor x 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*By default the values
are formatted using xaxis.hoverformat.
A string
A number that will be converted to a string
xperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the x axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘xperiod’ property accepts values of any type
Any
xperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the x0
axis. When x0period is round number of weeks, the x0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘xperiod0’ property accepts values of any type
Any
xperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis.
[‘start’, ‘middle’, ‘end’]
Any
xsrc¶Sets the source reference on Chart Studio Cloud for x.
The ‘xsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
y¶Sets the y coordinates.
The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
y0¶Alternate to y. Builds a linear space of y coordinates. Use
with dy where y0 is the starting coordinate and dy the
step.
The ‘y0’ property accepts values of any type
Any
yaxis¶Sets a reference between this trace’s y coordinates and a 2D
cartesian y axis. If “y” (the default value), the y coordinates
refer to layout.yaxis. If “y2”, the y coordinates refer to
layout.yaxis2, and so on.
The ‘yaxis’ property is an identifier of a particular subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)
yhoverformat¶Sets the hover text formatting rulefor y 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*By default the values
are formatted using yaxis.hoverformat.
A string
A number that will be converted to a string
yperiod¶Only relevant when the axis type is “date”. Sets the period
positioning in milliseconds or “M<n>” on the y axis. Special
values in the form of “M<n>” could be used to declare the
number of months. In this case n must be a positive integer.
The ‘yperiod’ property accepts values of any type
Any
yperiod0¶Only relevant when the axis type is “date”. Sets the base for
period positioning in milliseconds or date string on the y0
axis. When y0period is round number of weeks, the y0period0
by default would be on a Sunday i.e. 2000-01-02, otherwise it
would be at 2000-01-01.
The ‘yperiod0’ property accepts values of any type
Any
yperiodalignment¶Only relevant when the axis type is “date”. Sets the
alignment of data points on the y axis.
[‘start’, ‘middle’, ‘end’]
Any
ysrc¶Sets the source reference on Chart Studio Cloud for y.
The ‘ysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
zorder¶Sets the layer on which this trace is displayed, relative to
other SVG traces on the same subplot. SVG traces with higher
zorder appear in front of those with lower zorder.
An int (or float that will be cast to an int)
plotly.graph_objects.XAxis(*args, **kwargs)¶Bases: dict
plotly.graph_objects.XAxis is deprecated.
plotly.graph_objects.layout.XAxis
plotly.graph_objects.layout.scene.XAxis
plotly.graph_objects.XBins(*args, **kwargs)¶Bases: dict
plotly.graph_objects.XBins is deprecated.
plotly.graph_objects.histogram.XBins
plotly.graph_objects.histogram2d.XBins
plotly.graph_objects.YAxis(*args, **kwargs)¶Bases: dict
plotly.graph_objects.YAxis is deprecated.
plotly.graph_objects.layout.YAxis
plotly.graph_objects.layout.scene.YAxis
plotly.graph_objects.YBins(*args, **kwargs)¶Bases: dict
plotly.graph_objects.YBins is deprecated.
plotly.graph_objects.histogram.YBins
plotly.graph_objects.histogram2d.YBins
plotly.graph_objects.ZAxis(*args, **kwargs)¶Bases: dict
plotly.graph_objects.ZAxis is deprecated.
plotly.graph_objects.layout.scene.ZAxis