plotly.graph_objects package¶

class plotly.graph_objects.AngularAxis(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.AngularAxis is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.layout.AngularAxis
plotly.graph_objects.layout.polar.AngularAxis

class plotly.graph_objects.Annotation(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.Annotation is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.layout.Annotation
plotly.graph_objects.layout.scene.Annotation

class plotly.graph_objects.Annotations(*args, **kwargs)¶

Bases: list

plotly.graph_objects.Annotations is deprecated.

Please replace it with a list or tuple of instances of the following types

plotly.graph_objects.layout.Annotation
plotly.graph_objects.layout.scene.Annotation

class plotly.graph_objects.Area(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, r=None, rsrc=None, showlegend=None, stream=None, t=None, tsrc=None, uid=None, uirevision=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.area.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.area.Hoverlabel

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

An instance of plotly.graph_objects.area.Marker

A dict of string/value properties that will be passed to the Marker constructor

Supported dict properties:

color
Area traces are deprecated! Please switch to the “barpolar” trace type. Sets themarkercolor. 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.cmin and marker.cmax if set.

colorsrc
Sets the source reference on Chart Studio Cloud for color .

opacity
Area traces are deprecated! Please switch to the “barpolar” trace type. Sets the marker opacity.

opacitysrc
Sets the source reference on Chart Studio Cloud for opacity .

size
Area traces are deprecated! Please switch to the “barpolar” trace type. Sets the marker size (in px).

sizesrc
Sets the source reference on Chart Studio Cloud for size .

symbol
Area traces are deprecated! Please switch to the “barpolar” trace type. 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 .

Returns
Return type: plotly.graph_objects.area.Marker

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property r¶

Area traces are deprecated! Please switch to the “barpolar” trace type. Sets the radial coordinates for legacy polar chart only.

The ‘r’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.area.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.area.Stream

property t¶

Area traces are deprecated! Please switch to the “barpolar” trace type. Sets the angular coordinates for legacy polar chart only.

The ‘t’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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

Returns
Return type: Any

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

class plotly.graph_objects.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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, t=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property 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.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property 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)

Returns
Return type: bool

property constraintext¶

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

The ‘constraintext’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘inside’, ‘outside’, ‘both’, ‘none’]

Returns
Return type: Any

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property dx¶

Sets the x coordinate step. See x0 for more info.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property dy¶

Sets the y coordinate step. See y0 for more info.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property error_x¶

The ‘error_x’ property is an instance of ErrorX that may be specified as:

An instance of plotly.graph_objects.bar.ErrorX

A 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 stoke 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 in value. If “sqrt”, the bar lengths correspond to the sqaure of the underlying data. If “data”, the bar lengths are set with data set array.

value
Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is set to “constant”) corresponding to the lengths of the error bars.

valueminus
Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is 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.

Returns
Return type: plotly.graph_objects.bar.ErrorX

property error_y¶

The ‘error_y’ property is an instance of ErrorY that may be specified as:

An instance of plotly.graph_objects.bar.ErrorY

A 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 stoke 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 in value. If “sqrt”, the bar lengths correspond to the sqaure of the underlying data. If “data”, the bar lengths are set with data set array.

value
Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is set to “constant”) corresponding to the lengths of the error bars.

valueminus
Sets the value of either the percentage (if type is set to “percent”) or the constant (if type is 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.

Returns
Return type: plotly.graph_objects.bar.ErrorY

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.bar.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.bar.Hoverlabel

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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. 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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property insidetextanchor¶

Determines if texts are kept at center or start/end points in textposition “inside” mode.

The ‘insidetextanchor’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘end’, ‘middle’, ‘start’]

Returns
Return type: Any

property 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.Insidetextfont

A 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 .

size

sizesrc
Sets the source reference on Chart Studio Cloud for size .

Returns
Return type: plotly.graph_objects.bar.Insidetextfont

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

An instance of plotly.graph_objects.bar.Marker

A 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 by marker.colorscale. Has an effect only if in marker.color`is set to a numerical array. 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 in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color`is set to a numerical array. Defaults to `false when marker.cmin and marker.cmax are set by the user.

cmax
Sets the upper bound of the color domain. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color and if set, marker.cmin must be set as well.

cmid
Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color. Has no effect when marker.cauto is false.

cmin
Sets the lower bound of the color domain. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color and if set, marker.cmax must be set as well.

color
Sets themarkercolor. 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.cmin and marker.cmax if 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 r instance or dict with compatible properties

colorscale
Sets the colorscale. Has an effect only if in marker.color`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, use`marker.cmin` and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis.

colorsrc
Sets the source reference on Chart Studio Cloud for color .

line
plotly.graph_objects.bar.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.color`is set to a numerical array. If true, `marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

Returns
Return type: plotly.graph_objects.bar.Marker

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property 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.

The ‘offsetgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property orientation¶

Sets the orientation of the bars. With “v” (“h”), the value of the each bar spans along the vertical (horizontal).

The ‘orientation’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘v’, ‘h’]

Returns
Return type: Any

property 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.Outsidetextfont

A 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 .

size

sizesrc
Sets the source reference on Chart Studio Cloud for size .

Returns
Return type: plotly.graph_objects.bar.Outsidetextfont

property r¶

r coordinates in scatter traces are deprecated!Please switch to the “scatterpolar” trace type.Sets the radial coordinatesfor legacy polar chart only.

The ‘r’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property selected¶

The ‘selected’ property is an instance of Selected that may be specified as:

An instance of plotly.graph_objects.bar.Selected

A dict of string/value properties that will be passed to the Selected constructor

Supported dict properties:

marker
plotly.graph_objects.bar.selected.Marke r instance or dict with compatible properties

textfont
plotly.graph_objects.bar.selected.Textf ont instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.bar.Selected

property 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

Returns
Return type: Any

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.bar.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.bar.Stream

property t¶

t coordinates in scatter traces are deprecated!Please switch to the “scatterpolar” trace type.Sets the angular coordinatesfor legacy polar chart only.

The ‘t’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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).

Returns
Return type: int|float

property 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.Textfont

A 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 .

Returns
Return type: plotly.graph_objects.bar.Textfont

property 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.

The ‘textposition’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘inside’, ‘outside’, ‘auto’, ‘none’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: str

property 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-3.x-api- reference/blob/master/Formatting.md#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#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. variables value and label.

The ‘texttemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property unselected¶

The ‘unselected’ property is an instance of Unselected that may be specified as:

An instance of plotly.graph_objects.bar.Unselected

A dict of string/value properties that will be passed to the Unselected constructor

Supported dict properties:

marker
plotly.graph_objects.bar.unselected.Mar ker instance or dict with compatible properties

textfont
plotly.graph_objects.bar.unselected.Tex tfont instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.bar.Unselected

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property width¶

Sets the bar width (in position axis units).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property 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

Returns
Return type: str

property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property 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.)

Returns
Return type: str

property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property 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.)

Returns
Return type: str

property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

class 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, legendgroup=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

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property dr¶

Sets the r coordinate step.

The ‘dr’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property dtheta¶

Sets the theta coordinate step. By default, the dtheta step equals the subplot’s period divided by the length of the r coordinates.

The ‘dtheta’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.barpolar.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.barpolar.Hoverlabel

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

An instance of plotly.graph_objects.barpolar.Marker

A 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 by marker.colorscale. Has an effect only if in marker.color`is set to a numerical array. 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 in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color`is set to a numerical array. Defaults to `false when marker.cmin and marker.cmax are set by the user.

cmax
Sets the upper bound of the color domain. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color and if set, marker.cmin must be set as well.

cmid
Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color. Has no effect when marker.cauto is false.

cmin
Sets the lower bound of the color domain. Has an effect only if in marker.color`is set to a numerical array. Value should have the same units as in `marker.color and if set, marker.cmax must be set as well.

color
Sets themarkercolor. 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.cmin and marker.cmax if 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 lorBar instance or dict with compatible properties

colorscale
Sets the colorscale. Has an effect only if in marker.color`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, use`marker.cmin` and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E arth,Electric,Viridis,Cividis.

colorsrc
Sets the source reference on Chart Studio Cloud for color .

line
plotly.graph_objects.barpolar.marker.Li ne 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.color`is set to a numerical array. If true, `marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

Returns
Return type: plotly.graph_objects.barpolar.Marker

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property offset¶

Shifts the angular position where the bar is drawn (in “thetatunit” units).

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property 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

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property r¶

Sets the radial coordinates

The ‘r’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property 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

Returns
Return type: str

property selected¶

The ‘selected’ property is an instance of Selected that may be specified as:

An instance of plotly.graph_objects.barpolar.Selected

A dict of string/value properties that will be passed to the Selected constructor

Supported dict properties:

marker
plotly.graph_objects.barpolar.selected. Marker instance or dict with compatible properties

textfont
plotly.graph_objects.barpolar.selected. Textfont instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.barpolar.Selected

property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns
Return type: Any

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.barpolar.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.barpolar.Stream

property 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.)

Returns
Return type: str

property 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.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property theta¶

Sets the angular coordinates

The ‘theta’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property 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

Returns
Return type: str

property thetaunit¶

Sets the unit of input “theta” values. Has an effect only when on “linear” angular axes.

The ‘thetaunit’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘radians’, ‘degrees’, ‘gradians’]

Returns
Return type: Any

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property unselected¶

The ‘unselected’ property is an instance of Unselected that may be specified as:

An instance of plotly.graph_objects.barpolar.Unselected

A dict of string/value properties that will be passed to the Unselected constructor

Supported dict properties:

marker
plotly.graph_objects.barpolar.unselecte d.Marker instance or dict with compatible properties

textfont
plotly.graph_objects.barpolar.unselecte d.Textfont instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.barpolar.Unselected

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property width¶

Sets the bar angular width (in “thetaunit” units).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property 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

Returns
Return type: str

class 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, legendgroup=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, sdsrc=None, selected=None, selectedpoints=None, showlegend=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, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property 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.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.

The ‘boxmean’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, ‘sd’, False]

Returns
Return type: Any

property 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”.

The ‘boxpoints’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘outliers’, ‘suspectedoutliers’, False]

Returns
Return type: Any

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property dx¶

Sets the x coordinate step for multi-box traces set using q1/median/q3.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property dy¶

Sets the y coordinate step for multi-box traces set using q1/median/q3.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property fillcolor¶

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.box.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.box.Hoverlabel

property 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’)

Returns
Return type: Any

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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).

The ‘jitter’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property line¶

The ‘line’ property is an instance of Line that may be specified as:

An instance of plotly.graph_objects.box.Line

A 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).

Returns
Return type: plotly.graph_objects.box.Line

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

An instance of plotly.graph_objects.box.Marker

A dict of string/value properties that will be passed to the Marker constructor

Supported dict properties:

color
Sets themarkercolor. 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.cmin and marker.cmax if set.

line
plotly.graph_objects.box.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.

Returns
Return type: plotly.graph_objects.box.Marker

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear 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

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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)

Returns
Return type: bool

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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).

The ‘notchwidth’ property is a number and may be specified as:

An int or float in the interval [0, 0.5]

Returns
Return type: int|float

property 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.

The ‘offsetgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property orientation¶

Sets the orientation of the box(es). If “v” (“h”), the distribution is visualized along the vertical (horizontal).

The ‘orientation’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘v’, ‘h’]

Returns
Return type: Any

property 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

The ‘pointpos’ property is a number and may be specified as:

An int or float in the interval [-2, 2]

Returns
Return type: int|float

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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://www.amstat.org/publications/jse/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.

The ‘quartilemethod’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘linear’, ‘exclusive’, ‘inclusive’]

Returns
Return type: Any

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property selected¶

The ‘selected’ property is an instance of Selected that may be specified as:

An instance of plotly.graph_objects.box.Selected

A dict of string/value properties that will be passed to the Selected constructor

Supported dict properties:

marker
plotly.graph_objects.box.selected.Marke r instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.box.Selected

property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns
Return type: Any

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.box.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.box.Stream

property 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.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property unselected¶

The ‘unselected’ property is an instance of Unselected that may be specified as:

An instance of plotly.graph_objects.box.Unselected

A dict of string/value properties that will be passed to the Unselected constructor

Supported dict properties:

marker
plotly.graph_objects.box.unselected.Mar ker instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.box.Unselected

property 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 lower 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property 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).

The ‘whiskerwidth’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property 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.

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property xaxis¶

Returns
Return type: str

property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property yaxis¶

Returns
Return type: str

property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

class 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, legendgroup=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, xsrc=None, yaxis=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property close¶

Sets the close values.

The ‘close’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property decreasing¶

The ‘decreasing’ property is an instance of Decreasing that may be specified as:

An instance of plotly.graph_objects.candlestick.Decreasing

A 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.Line instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.candlestick.Decreasing

property high¶

Sets the high values.

The ‘high’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.candlestick.Hoverlabel

A 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 - 3 characters 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.

Returns
Return type: plotly.graph_objects.candlestick.Hoverlabel

property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property increasing¶

The ‘increasing’ property is an instance of Increasing that may be specified as:

An instance of plotly.graph_objects.candlestick.Increasing

A 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.Line instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.candlestick.Increasing

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property line¶

The ‘line’ property is an instance of Line that may be specified as:

An instance of plotly.graph_objects.candlestick.Line

A 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.width and decreasing.line.width.

Returns
Return type: plotly.graph_objects.candlestick.Line

property low¶

Sets the low values.

The ‘low’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property open¶

Sets the open values.

The ‘open’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns
Return type: Any

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.candlestick.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.candlestick.Stream

property 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.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property 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).

The ‘whiskerwidth’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property 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

Returns
Return type: numpy.ndarray

property xaxis¶

Returns
Return type: str

property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

property yaxis¶

Returns
Return type: str

class 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, 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, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property 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

Returns
Return type: numpy.ndarray

property a0¶

Alternate to a. Builds a linear space of a coordinates. Use with da where a0 is the starting coordinate and da the step.

The ‘a0’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property aaxis¶

The ‘aaxis’ property is an instance of Aaxis that may be specified as:

An instance of plotly.graph_objects.carpet.Aaxis

A 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 rangemode for more info. If range is provided, then autorange is set to False.

categoryarray
Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

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 categoryorder to category ascending or category descending if order should be determined by the alphanumerical order of the category names. Set categoryorder to “array” to derive the ordering from the attribute categoryarray. If a category is not found in the categoryarray array, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories in categoryarray.

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.

gridwidth
Sets the width (in px) of the axis line.

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.

minorgridcolor
Sets the color of the grid lines.

minorgridcount
Sets the number of minor grid ticks per major grid tick

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 if tickmode is set to “auto”.

range
Sets the range of this axis. If the axis type is “log”, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis type is “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

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 showtickprefix but 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 tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

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

titlefont
Deprecated: Please use carpet.aaxis.title.font instead. Sets this axis’ title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleoffset
Deprecated: Please use carpet.aaxis.title.offset instead. An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated titleoffset attribute.

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.

Returns
Return type: plotly.graph_objects.carpet.Aaxis

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property b0¶

Alternate to b. Builds a linear space of a coordinates. Use with db where b0 is the starting coordinate and db the step.

The ‘b0’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property baxis¶

The ‘baxis’ property is an instance of Baxis that may be specified as:

An instance of plotly.graph_objects.carpet.Baxis

A 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 rangemode for more info. If range is provided, then autorange is set to False.

categoryarray
Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

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 categoryorder to category ascending or category descending if order should be determined by the alphanumerical order of the category names. Set categoryorder to “array” to derive the ordering from the attribute categoryarray. If a category is not found in the categoryarray array, the sorting behavior for that attribute will be identical to the “trace” mode. The unspecified categories will follow the categories in categoryarray.

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.

gridwidth
Sets the width (in px) of the axis line.

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.

minorgridcolor
Sets the color of the grid lines.

minorgridcount
Sets the number of minor grid ticks per major grid tick

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 if tickmode is set to “auto”.

range
Sets the range of this axis. If the axis type is “log”, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis type is “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

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 showtickprefix but 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 tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

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

titlefont
Deprecated: Please use carpet.baxis.title.font instead. Sets this axis’ title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleoffset
Deprecated: Please use carpet.baxis.title.offset instead. An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated titleoffset attribute.

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.

Returns
Return type: plotly.graph_objects.carpet.Baxis

property 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

Returns
Return type: str

property carpet¶

An identifier for this carpet, so that scattercarpet and contourcarpet traces can specify a carpet plot on which they lie

The ‘carpet’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property cheaterslope¶

The shift applied to each successive row of data in creating a cheater plot. Only used if x is been ommitted.

The ‘cheaterslope’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property color¶

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property da¶

Sets the a coordinate step. See a0 for more info.

The ‘da’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property db¶

Sets the b coordinate step. See b0 for more info.

The ‘db’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.Font

A dict of string/value properties that will be passed to the Font constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Returns
Return type: plotly.graph_objects.carpet.Font

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.carpet.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.carpet.Stream

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property x¶

A two dimensional array of x coordinates at each carpet point. If ommitted, 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

Returns
Return type: numpy.ndarray

property xaxis¶

Returns
Return type: str

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property yaxis¶

Returns
Return type: str

property 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

Returns
Return type: str

class 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, legendgroup=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

property autocolorscale¶

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.)

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.choropleth.ColorBar

A 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 axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

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.

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 len to set the value.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

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 showtickprefix but 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 thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time- format#locale_format We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals .

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.choropleth.colorba r.Title instance or dict with compatible properties

titlefont
Deprecated: Please use choropleth.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use choropleth.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction).

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction).

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.choropleth.ColorBar

property 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis.

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’, ‘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’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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”.

The ‘featureidkey’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.)

Returns
Return type: str

property 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

Returns
Return type: Any

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.choropleth.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.choropleth.Hoverlabel

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.

The ‘locationmode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘ISO-3’, ‘USA-states’, ‘country names’, ‘geojson-id’]

Returns
Return type: Any

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

An instance of plotly.graph_objects.choropleth.Marker

A dict of string/value properties that will be passed to the Marker constructor

Supported dict properties:

line
plotly.graph_objects.choropleth.marker. Line instance or dict with compatible properties

opacity
Sets the opacity of the locations.

opacitysrc
Sets the source reference on Chart Studio Cloud for opacity .

Returns
Return type: plotly.graph_objects.choropleth.Marker

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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)

Returns
Return type: bool

property selected¶

The ‘selected’ property is an instance of Selected that may be specified as:

An instance of plotly.graph_objects.choropleth.Selected

A dict of string/value properties that will be passed to the Selected constructor

Supported dict properties:

marker
plotly.graph_objects.choropleth.selecte d.Marker instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.choropleth.Selected

property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns
Return type: Any

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.choropleth.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.choropleth.Stream

property text¶

Sets the text elements associated with each location.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property unselected¶

The ‘unselected’ property is an instance of Unselected that may be specified as:

An instance of plotly.graph_objects.choropleth.Unselected

A dict of string/value properties that will be passed to the Unselected constructor

Supported dict properties:

marker
plotly.graph_objects.choropleth.unselec ted.Marker instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.choropleth.Unselected

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property z¶

Sets the color values.

The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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)

Returns
Return type: bool

property 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.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class 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, legendgroup=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

property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.

The ‘below’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property coloraxis¶

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.choroplethmapbox.ColorBar

A 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 axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

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.

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 len to set the value.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

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 showtickprefix but 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 thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time- format#locale_format We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals .

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.choroplethmapbox.c olorbar.Title instance or dict with compatible properties

titlefont
Deprecated: Please use choroplethmapbox.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use choroplethmapbox.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction).

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction).

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.choroplethmapbox.ColorBar

property colorscale¶

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’, ‘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’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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”.

The ‘featureidkey’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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

Returns
Return type: Any

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.choroplethmapbox.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.choroplethmapbox.Hoverlabel

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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. 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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

An instance of plotly.graph_objects.choroplethmapbox.Marker

A dict of string/value properties that will be passed to the Marker constructor

Supported dict properties:

line
plotly.graph_objects.choroplethmapbox.m arker.Line instance or dict with compatible properties

opacity
Sets the opacity of the locations.

opacitysrc
Sets the source reference on Chart Studio Cloud for opacity .

Returns
Return type: plotly.graph_objects.choroplethmapbox.Marker

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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)

Returns
Return type: bool

property selected¶

The ‘selected’ property is an instance of Selected that may be specified as:

An instance of plotly.graph_objects.choroplethmapbox.Selected

A dict of string/value properties that will be passed to the Selected constructor

Supported dict properties:

marker
plotly.graph_objects.choroplethmapbox.s elected.Marker instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.choroplethmapbox.Selected

property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns
Return type: Any

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.choroplethmapbox.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.choroplethmapbox.Stream

property subplot¶

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.)

Returns
Return type: str

property text¶

Sets the text elements associated with each location.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property unselected¶

The ‘unselected’ property is an instance of Unselected that may be specified as:

An instance of plotly.graph_objects.choroplethmapbox.Unselected

A dict of string/value properties that will be passed to the Unselected constructor

Supported dict properties:

marker
plotly.graph_objects.choroplethmapbox.u nselected.Marker instance or dict with compatible properties

Returns
Return type: plotly.graph_objects.choroplethmapbox.Unselected

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property z¶

Sets the color values.

The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property zauto¶

The ‘zauto’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.ColorBar(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.ColorBar is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.marker.ColorBar
plotly.graph_objects.surface.ColorBar
etc.

class 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, legendgroup=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, uid=None, uirevision=None, usrc=None, v=None, visible=None, vsrc=None, w=None, wsrc=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property 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.

The ‘anchor’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘tip’, ‘tail’, ‘cm’, ‘center’]

Returns
Return type: Any

property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property 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.

The ‘cmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property cmid¶

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when cauto is false.

The ‘cmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘cmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property coloraxis¶

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.cone.ColorBar

A 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 axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

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.

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 len to set the value.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

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 showtickprefix but 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 thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time- format#locale_format We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals .

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.cone.colorbar.Titl e instance or dict with compatible properties

titlefont
Deprecated: Please use cone.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use cone.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction).

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction).

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.cone.ColorBar

property 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi ridis,Cividis.

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’, ‘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’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.cone.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.cone.Hoverlabel

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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. 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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property lighting¶

The ‘lighting’ property is an instance of Lighting that may be specified as:

An instance of plotly.graph_objects.cone.Lighting

A 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.

Returns
Return type: plotly.graph_objects.cone.Lighting

property lightposition¶

The ‘lightposition’ property is an instance of Lightposition that may be specified as:

An instance of plotly.graph_objects.cone.Lightposition

A 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.

Returns
Return type: plotly.graph_objects.cone.Lightposition

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property reversescale¶

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

The ‘reversescale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.)

Returns
Return type: str

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property 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).

The ‘sizemode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘scaled’, ‘absolute’]

Returns
Return type: Any

property 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 “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.

The ‘sizeref’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.cone.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.cone.Stream

property 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.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property type¶

property 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

Returns
Return type: numpy.ndarray

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class 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, legendgroup=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, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property coloraxis¶

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.contour.ColorBar

A 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 axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

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.

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 len to set the value.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

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 showtickprefix but 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 thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time- format#locale_format We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals .

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.contour.colorbar.T itle instance or dict with compatible properties

titlefont
Deprecated: Please use contour.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use contour.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction).

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction).

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.contour.ColorBar

property colorscale¶

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’, ‘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’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property 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)

Returns
Return type: bool

property contours¶

The ‘contours’ property is an instance of Contours that may be specified as:

An instance of plotly.graph_objects.contour.Contours

A 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-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format

operation
Sets the constraint operation. “=” keeps regions equal to value “<” and “<=” keep regions less than value “>” and “>=” keep regions greater than value “[]”, “()”, “[)”, and “(]” keep regions inside value[0] to value[1] “][“, “)(“, “](“, “)[” keep regions outside value[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.coloring is 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. If constraint, the data is represented as constraints with the invalid region shaded as specified by the operation and value parameters.

value
Sets the value or values of the constraint boundary. When operation is set to one of the comparison values (=,<,>=,>,<=) “value” is expected to be a number. When operation is 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.

Returns
Return type: plotly.graph_objects.contour.Contours

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property dx¶

Sets the x coordinate step. See x0 for more info.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property dy¶

Sets the y coordinate step. See y0 for more info.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to contour.colorscale

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.contour.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.contour.Hoverlabel

property 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)

Returns
Return type: bool

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property line¶

The ‘line’ property is an instance of Line that may be specified as:

An instance of plotly.graph_objects.contour.Line

A 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.coloring is 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.type is “levels”. Defaults to 2 when contour.type is “constraint”.

Returns
Return type: plotly.graph_objects.contour.Line

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.

The ‘ncontours’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]

Returns
Return type: int

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.contour.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.contour.Stream

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property transpose¶

Transposes the z data.

The ‘transpose’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property xaxis¶

Returns
Return type: str

property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

property 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).

The ‘xtype’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘array’, ‘scaled’]

Returns
Return type: Any

property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property yaxis¶

Returns
Return type: str

property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property 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

Returns
Return type: str

property 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)

The ‘ytype’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘array’, ‘scaled’]

Returns
Return type: Any

property z¶

Sets the z data.

The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property zauto¶

The ‘zauto’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property zhoverformat¶

Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format

The ‘zhoverformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class 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, legendgroup=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, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

property a¶

Sets the x coordinates.

The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property 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

Returns
Return type: str

property atype¶

The ‘atype’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘array’, ‘scaled’]

Returns
Return type: Any

property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property autocontour¶

The ‘autocontour’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property b¶

Sets the y coordinates.

The ‘b’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: Any

property 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

Returns
Return type: str

property btype¶

The ‘btype’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘array’, ‘scaled’]

Returns
Return type: Any

property carpet¶

The carpet of the carpet axes on which this contour trace lies

The ‘carpet’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property coloraxis¶

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.contourcarpet.ColorBar

A 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 axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

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.

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 len to set the value.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

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 showtickprefix but 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 thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time- format#locale_format We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals .

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.contourcarpet.colo rbar.Title instance or dict with compatible properties

titlefont
Deprecated: Please use contourcarpet.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use contourcarpet.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction).

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction).

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.contourcarpet.ColorBar

property colorscale¶

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’, ‘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’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property contours¶

The ‘contours’ property is an instance of Contours that may be specified as:

An instance of plotly.graph_objects.contourcarpet.Contours

A 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-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format

operation
Sets the constraint operation. “=” keeps regions equal to value “<” and “<=” keep regions less than value “>” and “>=” keep regions greater than value “[]”, “()”, “[)”, and “(]” keep regions inside value[0] to value[1] “][“, “)(“, “](“, “)[” keep regions outside value[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.coloring is 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. If constraint, the data is represented as constraints with the invalid region shaded as specified by the operation and value parameters.

value
Sets the value or values of the constraint boundary. When operation is set to one of the comparison values (=,<,>=,>,<=) “value” is expected to be a number. When operation is 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.

Returns
Return type: plotly.graph_objects.contourcarpet.Contours

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property da¶

Sets the x coordinate step. See x0 for more info.

The ‘da’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property db¶

Sets the y coordinate step. See y0 for more info.

The ‘db’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to contourcarpet.colorscale

Returns
Return type: str

property hovertext¶

Same as text.

The ‘hovertext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property line¶

The ‘line’ property is an instance of Line that may be specified as:

An instance of plotly.graph_objects.contourcarpet.Line

A 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.coloring is 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.type is “levels”. Defaults to 2 when contour.type is “constraint”.

Returns
Return type: plotly.graph_objects.contourcarpet.Line

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ncontours¶

The ‘ncontours’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]

Returns
Return type: int

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.contourcarpet.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.contourcarpet.Stream

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property transpose¶

Transposes the z data.

The ‘transpose’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property xaxis¶

Returns
Return type: str

property yaxis¶

Returns
Return type: str

property z¶

Sets the z data.

The ‘z’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property zauto¶

The ‘zauto’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.Contours(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.Contours is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.contour.Contours
plotly.graph_objects.surface.Contours
etc.

class plotly.graph_objects.Data(*args, **kwargs)¶

Bases: list

plotly.graph_objects.Data is deprecated.

Please replace it with a list or tuple of instances of the following types

plotly.graph_objects.Scatter
plotly.graph_objects.Bar
plotly.graph_objects.Area
plotly.graph_objects.Histogram
etc.

class 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, legendgroup=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

property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.

The ‘below’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property coloraxis¶

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.densitymapbox.ColorBar

A 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 axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

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.

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 len to set the value.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

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 showtickprefix but 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 thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -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: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time- format#locale_format We add one item to d3’s date formatter: “%{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.Tickformatstop instances 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

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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 if tickmode is set to “array”. Used with tickvals.

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 tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals .

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.densitymapbox.colo rbar.Title instance or dict with compatible properties

titlefont
Deprecated: Please use densitymapbox.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use densitymapbox.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position of the color bar (in plot fraction).

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

xpad
Sets the amount of padding (in px) along the x direction.

y
Sets the y position of the color bar (in plot fraction).

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

ypad
Sets the amount of padding (in px) along the y direction.

Returns
Return type: plotly.graph_objects.densitymapbox.ColorBar

property colorscale¶

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’, ‘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’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.densitymapbox.Hoverlabel

A 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 - 3 characters and add an ellipsis.

namelengthsrc
Sets the source reference on Chart Studio Cloud for namelength .

Returns
Return type: plotly.graph_objects.densitymapbox.Hoverlabel

property 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property legendgroup¶

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property 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

Returns
Return type: numpy.ndarray

property 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

Returns
Return type: str

property meta¶

The ‘meta’ property accepts values of any type

Returns
Return type: Any|numpy.ndarray

property 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

Returns
Return type: str

property name¶

Sets the trace name. The trace name appear as the legend item and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

property radius¶

Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

The ‘radius’ property is a number and may be specified as:

An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property 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

Returns
Return type: str

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property 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)

Returns
Return type: bool

property stream¶

The ‘stream’ property is an instance of Stream that may be specified as:

An instance of plotly.graph_objects.densitymapbox.Stream

A 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 maxpoints is 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.

Returns
Return type: plotly.graph_objects.densitymapbox.Stream

property subplot¶

Returns
Return type: str

property 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.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property 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

Returns
Return type: str

property type¶

property uid¶

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns
Return type: Any

property 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).

The ‘visible’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘legendonly’]

Returns
Return type: Any

property 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

Returns
Return type: numpy.ndarray

property zauto¶

The ‘zauto’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property 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.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.ErrorX(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.ErrorX is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.ErrorX
plotly.graph_objects.histogram.ErrorX
etc.

class plotly.graph_objects.ErrorY(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.ErrorY is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.ErrorY
plotly.graph_objects.histogram.ErrorY
etc.

class plotly.graph_objects.ErrorZ(*args, **kwargs)¶

Bases: dict

plotly.graph_objects.ErrorZ is deprecated.

Please replace it with one of the following more specific types

plotly.graph_objects.scatter3d.ErrorZ

class 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, **kwargs)¶

Create and add a new annotation to the figure’s layout

Parameters

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 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 an axis, this is an absolute value on that axis, like x, NOT a relative value.
axref – Indicates in what terms the tail of the annotation (ax,ay) is specified. If pixel, ax is a relative offset in pixels from x. If set to an x axis id (e.g. “x” or “x2”), ax is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed.
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 an axis, this is an absolute value on that axis, like y, NOT a relative value.
ayref – Indicates in what terms the tail of the annotation (ax,ay) is specified. If pixel, ay is a relative offset in pixels from y. If set to a y axis id (e.g. “y” or “y2”), ay is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed.
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 ( ), bold (), italics (), hyperlinks (<a href=’…’></a>). Tags , , 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 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 an x axis id (e.g. “x” or “x2”), the x position refers to an x coordinate If set to “paper”, the x position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side.
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 an y axis id (e.g. “y” or “y2”), the y position refers to an 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).
yshift – Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
row – Subplot row for annotation
col – Subplot column for annotation
secondary_y – Whether to add annotation to secondary y-axis

Returns

Return type

Figure

add_area(customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, r=None, rsrc=None, showlegend=None, stream=None, t=None, tsrc=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Area trace

Parameters

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.area.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 .
legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
marker – plotly.graph_objects.area.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 appear as the legend item and on hover.
opacity – Sets the opacity of the trace.
r – Area traces are deprecated! Please switch to the “barpolar” trace type. Sets the radial coordinates for legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r .
showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream – plotly.graph_objects.area.Stream instance or dict with compatible properties
t – Area traces are deprecated! Please switch to the “barpolar” trace type. Sets the angular coordinates for legacy polar chart only.
tsrc – Sets the source reference on Chart Studio Cloud for t .
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 (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
col (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

Returns

Return type

Figure

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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, t=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Bar trace

The data visualized by the span of the bars is set in y if orientation is set th “v” (the default) and the labels are set in x. By setting orientation to “h”, the roles are interchanged.

Parameters

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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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. 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.
legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
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 appear 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.
r – r coordinates in scatter traces are deprecated!Please switch to the “scatterpolar” trace type.Sets the radial coordinatesfor legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r .
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
t – t coordinates in scatter traces are deprecated!Please switch to the “scatterpolar” trace type.Sets the angular coordinatesfor legacy polar chart only.
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.
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-3.x-api- reference/blob/master/Formatting.md#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#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. variables value and label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate .
tsrc – Sets the source reference on Chart Studio Cloud for t .
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.
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.
ysrc – Sets the source reference on Chart Studio Cloud for y .
row (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
col (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
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.

Returns

Return type

Figure

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, legendgroup=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)¶

Add a new Barpolar trace

The data visualized by the radial span of the bars is set in r

Parameters

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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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 .
legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
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 appear 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 (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
col (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

Returns

Return type

Figure

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, legendgroup=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, sdsrc=None, selected=None, selectedpoints=None, showlegend=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, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

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.

Parameters

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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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).
legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
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 appear 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://www.amstat.org/publication s/jse/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.
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.
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 lower 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.
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.
ysrc – Sets the source reference on Chart Studio Cloud for y .
row (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
col (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
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.

Returns

Return type

Figure

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, legendgroup=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, xsrc=None, yaxis=None, row=None, col=None, secondary_y=None, **kwargs)¶

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.

Parameters

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
legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
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 appear 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.
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.
row (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
col (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
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.

Returns

Return type

Figure

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, 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, row=None, col=None, secondary_y=None, **kwargs)¶

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.

Parameters

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 ommitted.
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 .
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 appear 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 ommitted, 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 .
row (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
col (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
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.

Returns

Return type

Figure

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, legendgroup=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)¶

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.

Parameters

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: Greys,YlGnBu,Greens,YlOrR d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H ot,Blackbody,Earth,Electric,Viridis,Cividis.
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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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#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 .
legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
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