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.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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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

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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

Returns

Return type

plotly.graph_objects.bar.Insidetextfont

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.bar.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.bar.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

Returns

Return type

plotly.graph_objects.bar.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 appears 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

Returns

Return type

plotly.graph_objects.bar.Outsidetextfont

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

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

Returns

Return type

plotly.graph_objects.bar.Stream

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

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. If “none”, no text appears.

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.barpolar.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.barpolar.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

Returns

Return type

plotly.graph_objects.barpolar.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 appears 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

Returns

Return type

plotly.graph_objects.barpolar.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.barpolar.Stream

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

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

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

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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: see https://plotly.com/python/css-colors/ for a list

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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.box.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.box.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

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

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

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 appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical

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://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

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 sdmultiple

Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev

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

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

Returns

Return type

int|float

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

Returns

Return type

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

Determines whether or not whiskers are visible. Defaults to true for sizemode “quartiles”, false for “sd”.

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

Returns

Return type

bool

property sizemode

Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc

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

• One of the following enumeration values:

  [‘quartiles’, ‘sd’]

Returns

Return type

Any

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

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

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

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 upper as the last sample point above 1.5 times the IQR.

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

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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

Returns

Return type

plotly.graph_objects.candlestick.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables open, high, low and close. 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

Returns

Return type

plotly.graph_objects.candlestick.Increasing

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.candlestick.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.candlestick.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

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

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 appears 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

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.candlestick.Stream

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

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

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

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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

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

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: see https://plotly.com/python/css-colors/ for a list

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

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.carpet.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.carpet.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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 appears 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

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

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

property x

A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.

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

Returns

Return type

numpy.ndarray

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

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 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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.choropleth.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.choropleth.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property locationmode

The library used by the country names locationmode option is changing in an upcoming version. Country names in existing plots may not work in the new version. 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

Returns

Return type

plotly.graph_objects.choropleth.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 appears 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

Returns

Return type

plotly.graph_objects.choropleth.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 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

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

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

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.Choroplethmap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 below

Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.

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

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.choroplethmap.ColorBar

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

Returns

Return type

plotly.graph_objects.choroplethmap.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

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

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

Returns

Return type

plotly.graph_objects.choroplethmap.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.choroplethmap.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.choroplethmap.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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.choroplethmap.Marker

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

Returns

Return type

plotly.graph_objects.choroplethmap.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 appears 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.choroplethmap.Selected

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

Returns

Return type

plotly.graph_objects.choroplethmap.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 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.choroplethmap.Stream

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

Returns

Return type

plotly.graph_objects.choroplethmap.Stream

property subplot

Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘map’, that may be specified as the string ‘map’ optionally followed by an integer >= 1 (e.g. ‘map’, ‘map1’, ‘map2’, ‘map3’, etc.)

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

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 unselected

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

• An instance of plotly.graph_objects.choroplethmap.Unselected

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

Returns

Return type

plotly.graph_objects.choroplethmap.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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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.choroplethmapbox.ColorBar

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

Returns

Return type

plotly.graph_objects.choroplethmapbox.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.choroplethmapbox.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.choroplethmapbox.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

Returns

Return type

plotly.graph_objects.choroplethmapbox.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 appears 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

Returns

Return type

plotly.graph_objects.choroplethmapbox.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 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

Returns

Return type

plotly.graph_objects.choroplethmapbox.Stream

property subplot

mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘mapbox’, that may be specified as the string ‘mapbox’ optionally followed by an integer >= 1 (e.g. ‘mapbox’, ‘mapbox1’, ‘mapbox2’, ‘mapbox3’, etc.)

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

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

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

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.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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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

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.cone.ColorBar

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

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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable norm Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.cone.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.cone.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

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

Returns

Return type

plotly.graph_objects.cone.Lightposition

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 appears 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). To display sizes in actual vector length use “raw”.

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

• One of the following enumeration values:

  [‘scaled’, ‘absolute’, ‘raw’]

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 “raw”, its default value is 1. With sizemode set to “scaled”, sizeref is unitless, its default value is 0.5. With sizemode set to “absolute”, sizeref has the same units as the u/v/w vector field, its the default value is half the sample’s maximum vector norm.

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

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 uhoverformat

Sets the hover text formatting rulefor u using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘uhoverformat’ 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 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 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 vhoverformat

Sets the hover text formatting rulefor v using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘vhoverformat’ 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 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 whoverformat

Sets the hover text formatting rulefor w using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘whoverformat’ 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 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 xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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.contour.ColorBar

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

Returns

Return type

plotly.graph_objects.contour.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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

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: see https://plotly.com/python/css-colors/ for a list

• 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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.contour.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.contour.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

Returns

Return type

plotly.graph_objects.contour.Line

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 appears 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

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 textfont

For this trace it only has an effect if coloring is set to “heatmap”. Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.contour.Textfont

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

Returns

Return type

plotly.graph_objects.contour.Textfont

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

For this trace it only has an effect if coloring is set to “heatmap”. Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

The ‘texttemplate’ 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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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 ‘atype’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘array’, ‘scaled’]

Returns

Return type

Any

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

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 ‘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

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.contourcarpet.ColorBar

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

Returns

Return type

plotly.graph_objects.contourcarpet.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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

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: see https://plotly.com/python/css-colors/ for a list

• 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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.contourcarpet.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.contourcarpet.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

Returns

Return type

plotly.graph_objects.contourcarpet.Line

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 appears 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.contourcarpet.Stream

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

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

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

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

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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.Densitymap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 below

Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.

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

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.densitymap.ColorBar

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

Returns

Return type

plotly.graph_objects.densitymap.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

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

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

Returns

Return type

plotly.graph_objects.densitymap.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.densitymap.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.densitymap.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

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 appears 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 densitymap 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.densitymap.Stream

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

Returns

Return type

plotly.graph_objects.densitymap.Stream

property subplot

Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘map’, that may be specified as the string ‘map’ optionally followed by an integer >= 1 (e.g. ‘map’, ‘map1’, ‘map2’, ‘map3’, etc.)

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

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

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

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.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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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

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.densitymapbox.ColorBar

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

Returns

Return type

plotly.graph_objects.densitymapbox.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.densitymapbox.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.densitymapbox.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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

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 appears 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

Returns

Return type

plotly.graph_objects.densitymapbox.Stream

property subplot

mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘mapbox’, that may be specified as the string ‘mapbox’ optionally followed by an integer >= 1 (e.g. ‘mapbox’, ‘mapbox1’, ‘mapbox2’, ‘mapbox3’, etc.)

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

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

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

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.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, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure

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 <br> HTML tags) or if an explicit width is set to override the text width.

• arrowcolor – Sets the color of the annotation arrow.

• arrowhead – Sets the end annotation arrow head style.

• arrowside – Sets the annotation arrow head position.

• arrowsize – Sets the size of the end annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line.

• arrowwidth – Sets the width (in px) of annotation arrow line.

• ax – Sets the x component of the arrow tail about the arrow head. If axref is pixel, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If axref is not pixel and is exactly the same as xref, this is an absolute value on that axis, like x, specified in the same coordinates as xref.

• axref – Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. In order for absolute positioning of the arrow to work, “axref” must be exactly the same as “xref”, otherwise “axref” will revert to “pixel” (explained next). For relative positioning, “axref” can be set to “pixel”, in which case the “ax” value is specified in pixels relative to “x”. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

• ay – Sets the y component of the arrow tail about the arrow head. If ayref is pixel, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If ayref is not pixel and is exactly the same as yref, this is an absolute value on that axis, like y, specified in the same coordinates as yref.

• ayref – Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. In order for absolute positioning of the arrow to work, “ayref” must be exactly the same as “yref”, otherwise “ayref” will revert to “pixel” (explained next). For relative positioning, “ayref” can be set to “pixel”, in which case the “ay” value is specified in pixels relative to “y”. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

• bgcolor – Sets the background color of the annotation.

• bordercolor – Sets the color of the border enclosing the annotation text.

• borderpad – Sets the padding (in px) between the text and the enclosing border.

• borderwidth – Sets the width (in px) of the border enclosing the annotation text.

• captureevents – Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default captureevents is False unless hovertext is provided. If you use the event plotly_clickannotation without hovertext you must explicitly enable captureevents.

• clicktoshow – Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the x and y values of this annotation, and it is hidden (visible: false), it will appear. In “onoff” mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In “onout” mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different x or y values, you can set xclick and/or yclick. This is useful for example to label the side of a bar. To label markers though, standoff is preferred over xclick and yclick.

• font – Sets the annotation text font.

• height – Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.

• hoverlabel – plotly.graph_objects.layout.annotation.Hoverlab el instance or dict with compatible properties

• hovertext – Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the annotation (text + arrow).

• showarrow – Determines whether or not the annotation is drawn with an arrow. If True, text is placed near the arrow’s tail. If False, text lines up with the x and y provided.

• standoff – Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount.

• startarrowhead – Sets the start annotation arrow head style.

• startarrowsize – Sets the size of the start annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line.

• startstandoff – Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• text – Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>, and <span> are also supported.

• textangle – Sets the angle at which the text is drawn with respect to the horizontal.

• valign – Sets the vertical alignment of the text within the box. Has an effect only if an explicit height is set to override the text height.

• visible – Determines whether or not this annotation is visible.

• width – Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.

• x – Sets the annotation’s x position. If the axis type is “log”, then you must take the log of your desired range. If the axis type is “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

• xanchor – Sets the text box’s horizontal position anchor This anchor binds the x position to the “left”, “center” or “right” of the annotation. For example, if x is set to 1, xref to “paper” and xanchor to “right” then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If “auto”, the anchor is equivalent to “center” for data- referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

• xclick – Toggle this annotation when clicking a data point whose x value is xclick rather than the annotation’s x value.

• xref – Sets the annotation’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• xshift – Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.

• y – Sets the annotation’s y position. If the axis type is “log”, then you must take the log of your desired range. If the axis type is “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

• yanchor – Sets the text box’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the annotation. For example, if y is set to 1, yref to “paper” and yanchor to “top” then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If “auto”, the anchor is equivalent to “middle” for data-referenced annotations or if there is an arrow, whereas for paper- referenced with no arrow, the anchor picked corresponds to the closest side.

• yclick – Toggle this annotation when clicking a data point whose y value is yclick rather than the annotation’s y value.

• yref – Sets the annotation’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• yshift – Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.

• row – Subplot row for annotation. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for annotation. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add annotation to secondary y-axis

• exclude_empty_subplots – If True, annotation will not be added to subplots without traces.

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Bar trace

The data visualized by the span of the bars is set in y if orientation is set to “v” (the default) and the labels are set in x. By setting orientation to “h”, the roles are interchanged.

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.bar.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.bar.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• offsetsrc – Sets the source reference on Chart Studio Cloud for offset.

• opacity – Sets the opacity of the trace.

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

• outsidetextfont – Sets the font used for text lying outside the bar.

• selected – plotly.graph_objects.bar.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.bar.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the font used for text.

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.bar.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the bar width (in position axis units).

• widthsrc – Sets the source reference on Chart Studio Cloud for width.

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Barpolar trace

The data visualized by the radial span of the bars is set in r

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.barpolar.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

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

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

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

• offsetsrc – Sets the source reference on Chart Studio Cloud for offset.

• opacity – Sets the opacity of the trace.

• r – Sets the radial coordinates

• r0 – Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

• rsrc – Sets the source reference on Chart Studio Cloud for r.

• selected – plotly.graph_objects.barpolar.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.barpolar.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a polar subplot. If “polar” (the default value), the data refer to layout.polar. If “polar2”, the data refer to layout.polar2, and so on.

• text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• theta – Sets the angular coordinates

• theta0 – Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

• thetasrc – Sets the source reference on Chart Studio Cloud for theta.

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

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.barpolar.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

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

• widthsrc – Sets the source reference on Chart Studio Cloud for width.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Box trace

Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes’ edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the y data array for vertical boxes (x for horizontal boxes). By supplying an x (y) array, one box per distinct x (y) value is drawn If no x (y) list is provided, a single box is drawn. In this case, the box is positioned with the trace name or with x0 (y0) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the q1, median and q3 data arrays respectively. Other box features relying on statistics namely lowerfence, upperfence, notchspan can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the y data array for vertical boxes (x for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size.

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• jitter – Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es).

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.box.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.box.Line instance or dict with compatible properties

• lowerfence – Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If lowerfence is not provided but a sample (in y or x) is set, we compute the lower as the last sample point below 1.5 times the IQR.

• lowerfencesrc – Sets the source reference on Chart Studio Cloud for lowerfence.

• marker – plotly.graph_objects.box.Marker instance or dict with compatible properties

• mean – Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If mean is not provided but a sample (in y or x) is set, we compute the mean for each box using the sample values.

• meansrc – Sets the source reference on Chart Studio Cloud for mean.

• median – Sets the median values. There should be as many items as the number of boxes desired.

• mediansrc – Sets the source reference on Chart Studio Cloud for median.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical

• notched – Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes’ notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home /notched-box-plots for more info. Defaults to False unless notchwidth or notchspan is set.

• notchspan – Sets the notch span from the boxes’ median values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If notchspan is not provided but a sample (in y or x) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size.

• notchspansrc – Sets the source reference on Chart Studio Cloud for notchspan.

• notchwidth – Sets the width of the notches relative to the box width. For example, with 0, the notches are as wide as the box(es).

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

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

• pointpos – Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes

• q1 – Sets the Quartile 1 values. There should be as many items as the number of boxes desired.

• q1src – Sets the source reference on Chart Studio Cloud for q1.

• q3 – Sets the Quartile 3 values. There should be as many items as the number of boxes desired.

• q3src – Sets the source reference on Chart Studio Cloud for q3.

• quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

• sd – Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If sd is not provided but a sample (in y or x) is set, we compute the standard deviation for each box using the sample values.

• sdmultiple – Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev

• sdsrc – Sets the source reference on Chart Studio Cloud for sd.

• selected – plotly.graph_objects.box.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showwhiskers – Determines whether or not whiskers are visible. Defaults to true for sizemode “quartiles”, false for “sd”.

• sizemode – Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc

• stream – plotly.graph_objects.box.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.box.Unselected instance or dict with compatible properties

• upperfence – Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If upperfence is not provided but a sample (in y or x) is set, we compute the upper as the last sample point above 1.5 times the IQR.

• upperfencesrc – Sets the source reference on Chart Studio Cloud for upperfence.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• whiskerwidth – Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).

• width – Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot.

• x – Sets the x sample data or coordinates. See overview for more info.

• x0 – Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y sample data or coordinates. See overview for more info.

• y0 – Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

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, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Candlestick trace

The candlestick is a style of financial chart describing open, high, low and close for a given x coordinate (most likely time). The boxes represent the spread between the open and close values and the lines represent the spread between the low and high values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red.

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

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables open, high, low and close. 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• increasing – plotly.graph_objects.candlestick.Increasing instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.candlestick.Legendgrouptit le instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.candlestick.Line instance or dict with compatible properties

• low – Sets the low values.

• lowsrc – Sets the source reference on Chart Studio Cloud for low.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• open – Sets the open values.

• opensrc – Sets the source reference on Chart Studio Cloud for open.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.candlestick.Stream instance or dict with compatible properties

• text – Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• whiskerwidth – Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).

• x – Sets the x coordinates. If absent, linear coordinate will be generated.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

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, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Carpet trace

The data describing carpet axis layout is set in y and (optionally) also x. If only y is present, x the plot is interpreted as a cheater plot and is filled in using the y values. x and y may either be 2D arrays matching with each dimension matching that of a and b, or they may be 1D arrays with total length equal to that of a and b.

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

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

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• da – Sets the a coordinate step. See a0 for more info.

• db – Sets the b coordinate step. See b0 for more info.

• font – The default font used for axis & tick labels on this carpet

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.carpet.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• stream – plotly.graph_objects.carpet.Stream instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – A two dimensional array of y coordinates at each carpet point.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Choropleth trace

The data that describes the choropleth value-to-color mapping is set in z. The geographic locations corresponding to each value in z are set in locations.

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: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example “properties.name”.

• geo – Sets a reference between this trace’s geospatial coordinates and a geographic map. If “geo” (the default value), the geospatial coordinates refer to layout.geo. If “geo2”, the geospatial coordinates refer to layout.geo2, and so on.

• geojson – Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.choropleth.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.choropleth.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locationmode – The library used by the country names locationmode option is changing in an upcoming version. Country names in existing plots may not work in the new version. Determines the set of locations used to match entries in locations to regions on the map. Values “ISO-3”, “USA-states”, country names correspond to features on the base map and value “geojson-id” corresponds to features from a custom GeoJSON linked to the geojson attribute.

• locations – Sets the coordinates via location IDs or names. See locationmode for more info.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• marker – plotly.graph_objects.choropleth.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• selected – plotly.graph_objects.choropleth.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.choropleth.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each location.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.choropleth.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the color values.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_choroplethmap(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Choroplethmap trace

GeoJSON features to be filled are set in geojson The data that describes the choropleth value-to-color mapping is set in locations and z.

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.

• below – Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.choroplethmap.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Support nested property, for example “properties.name”.

• geojson – Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.choroplethmap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.choroplethmap.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locations – Sets which features found in “geojson” to plot using their feature id field.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• marker – plotly.graph_objects.choroplethmap.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• selected – plotly.graph_objects.choroplethmap.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.choroplethmap.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

• text – Sets the text elements associated with each location.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.choroplethmap.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the color values.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_choroplethmapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Choroplethmapbox trace

“choroplethmapbox” trace is deprecated! Please consider switching to the “choroplethmap” trace type and map subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ GeoJSON features to be filled are set in geojson The data that describes the choropleth value-to-color mapping is set in locations and z.

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.

• below – Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.choroplethmapbox.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Support nested property, for example “properties.name”.

• geojson – Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.choroplethmapbox.Hoverlabe l instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.choroplethmapbox.Legendgro uptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locations – Sets which features found in “geojson” to plot using their feature id field.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• marker – plotly.graph_objects.choroplethmapbox.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• selected – plotly.graph_objects.choroplethmapbox.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.choroplethmapbox.Stream instance or dict with compatible properties

• subplot – mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre- migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

• text – Sets the text elements associated with each location.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.choroplethmapbox.Unselecte d instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the color values.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_cone(anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Cone trace

Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays x, y and z and 3 vector component arrays u, v, w. The cones are drawn exactly at the positions given by x, y and z.

Parameters

• anchor – Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.

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

• cauto – Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.cone.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.cone.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable norm Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.cone.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.cone.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.cone.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• sizemode – Determines whether sizeref is set as a “scaled” (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as “absolute” value (in the same units as the vector field). To display sizes in actual vector length use “raw”.

• sizeref – Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and sizeref. This factor (computed internally) corresponds to the minimum “time” to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With sizemode set to “raw”, its default value is 1. With sizemode set to “scaled”, sizeref is unitless, its default value is 0.5. With sizemode set to “absolute”, sizeref has the same units as the u/v/w vector field, its the default value is half the sample’s maximum vector norm.

• stream – plotly.graph_objects.cone.Stream instance or dict with compatible properties

• text – Sets the text elements associated with the cones. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• u – Sets the x components of the vector field.

• uhoverformat – Sets the hover text formatting rulefor u using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• usrc – Sets the source reference on Chart Studio Cloud for u.

• v – Sets the y components of the vector field.

• vhoverformat – Sets the hover text formatting rulefor v using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• vsrc – Sets the source reference on Chart Studio Cloud for v.

• w – Sets the z components of the vector field.

• whoverformat – Sets the hover text formatting rulefor w using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• wsrc – Sets the source reference on Chart Studio Cloud for w.

• x – Sets the x coordinates of the vector field and of the displayed cones.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates of the vector field and of the displayed cones.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates of the vector field and of the displayed cones.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_contour(autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Contour trace

The data from which contour lines are computed is set in z. Data in z must be a 2D list of numbers. Say that z has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in y or auto-generated) and the M columns correspond to M x coordinates (set in x or auto- generated). By setting transpose to True, the above behavior is flipped.

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.

• autocontour – Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in ncontours. If False, set the contour level attributes in contours.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.contour.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array otherwise it is defaulted to false.

• contours – plotly.graph_objects.contour.Contours instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• fillcolor – Sets the fill color if contours.type is “constraint”. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.contour.Hoverlabel instance or dict with compatible properties

• hoverongaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data have hover labels associated with them.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.contour.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.contour.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• ncontours – Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is True or if contours.size is missing.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.contour.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textfont – For this trace it only has an effect if coloring is set to “heatmap”. Sets the text font.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – For this trace it only has an effect if coloring is set to “heatmap”. Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• transpose – Transposes the z data.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• xtype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when x is provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior when x is not provided).

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• ytype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when y is provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior when y is not provided)

• z – Sets the z data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_contourcarpet(a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Contourcarpet trace

Plots contours on either the first carpet axis or the carpet axis with a matching carpet attribute. Data z is interpreted as matching that of the corresponding carpet axis.

Parameters

• a – Sets the x coordinates.

• a0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• asrc – Sets the source reference on Chart Studio Cloud for a.

• atype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when x is provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior when x is not provided).

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

• autocontour – Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in ncontours. If False, set the contour level attributes in contours.

• b – Sets the y coordinates.

• b0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• bsrc – Sets the source reference on Chart Studio Cloud for b.

• btype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when y is provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior when y is not provided)

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

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.contourcarpet.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contours – plotly.graph_objects.contourcarpet.Contours instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• da – Sets the x coordinate step. See x0 for more info.

• db – Sets the y coordinate step. See y0 for more info.

• fillcolor – Sets the fill color if contours.type is “constraint”. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.contourcarpet.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.contourcarpet.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• ncontours – Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is True or if contours.size is missing.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.contourcarpet.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• transpose – Transposes the z data.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• z – Sets the z data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_densitymap(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Densitymap trace

Draws a bivariate kernel density estimation with a Gaussian kernel from lon and lat coordinates and optional z values using a colorscale.

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.

• below – Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.densitymap.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.densitymap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.densitymap.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• radius – Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymap trace smoother, but less detailed.

• radiussrc – Sets the source reference on Chart Studio Cloud for radius.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.densitymap.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_densitymapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Densitymapbox trace

“densitymapbox” trace is deprecated! Please consider switching to the “densitymap” trace type and map subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Draws a bivariate kernel density estimation with a Gaussian kernel from lon and lat coordinates and optional z values using a colorscale.

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.

• below – Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.densitymapbox.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.densitymapbox.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.densitymapbox.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• radius – Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

• radiussrc – Sets the source reference on Chart Studio Cloud for radius.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.densitymapbox.Stream instance or dict with compatible properties

• subplot – mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre- migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_funnel(alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Funnel trace

Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a “drop-off” representation wherein each item appears in each stage it traversed. See also the “funnelarea” trace type for a different approach to visualizing funnel data.

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.

• cliponaxis – Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connector – plotly.graph_objects.funnel.Connector instance or dict with compatible properties

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

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.funnel.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious and percentTotal. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.funnel.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.funnel.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

• orientation – Sets the orientation of the funnels. With “v” (“h”), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only “y” array is presented or orientation is set to “v”. Also regarding graphs including only ‘horizontal’ funnels, “autorange” on the “y-axis” are set to “reversed”.

• outsidetextfont – Sets the font used for text lying outside the bar.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.funnel.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the font used for text.

• textinfo – Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious, percentTotal, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the bar width (in position axis units).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_funnelarea(aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Funnelarea trace

Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a “pie” trace, wherein each item appears in a single stage. See also the “funnel” trace type for a different approach to visualizing funnel data.

Parameters

• aspectratio – Sets the ratio between height and width

• baseratio – Sets the ratio between bottom length and maximum top length.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dlabel – Sets the label step. See label0 for more info.

• domain – plotly.graph_objects.funnelarea.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.funnelarea.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• label0 – Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

• labels – Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.funnelarea.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.funnelarea.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• scalegroup – If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.funnelarea.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Specifies the location of the textinfo.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• title – plotly.graph_objects.funnelarea.Title instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values of the sectors. If omitted, we count occurrences of each label.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_heatmap(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Heatmap trace

The data that describes the heatmap value-to-color mapping is set in z. Data in z can either be a 2D list of values (ragged or not) or a 1D array of values. In the case where z is a 2D list, say that z has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in z is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using transpose. Moreover, x (y) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where z is a 1D list, the x and y coordinates must be provided in x and y respectively to form data triplets.

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.heatmap.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array and zsmooth is not false; otherwise it is defaulted to false.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.heatmap.Hoverlabel instance or dict with compatible properties

• hoverongaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data have hover labels associated with them.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.heatmap.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.heatmap.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textfont – Sets the text font.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• transpose – Transposes the z data.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xgap – Sets the horizontal gap (in pixels) between bricks.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• xtype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when x is provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior when x is not provided).

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• ygap – Sets the vertical gap (in pixels) between bricks.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• ytype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when y is provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior when y is not provided)

• z – Sets the z data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsmooth – Picks a smoothing algorithm use to smooth z data.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_histogram(alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Histogram trace

The sample data from which statistics are computed is set in x for vertically spanning histograms and in y for horizontally spanning histograms. Binning options are set xbins and ybins respectively if no aggregation data is provided.

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.

• autobinx – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

• autobiny – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

• bingroup – Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same “orientation” under barmode “stack”, “relative” and “group” are forced into the same bingroup, Using bingroup, traces under barmode “overlay” and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same bingroup

• cliponaxis – Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

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

• cumulative – plotly.graph_objects.histogram.Cumulative instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• error_x – plotly.graph_objects.histogram.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.histogram.ErrorY instance or dict with compatible properties

• histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

• histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.histogram.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable binNumber Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.histogram.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.histogram.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• nbinsx – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

• nbinsy – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

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

• outsidetextfont – Sets the font used for text lying outside the bar.

• selected – plotly.graph_objects.histogram.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.histogram.Stream instance or dict with compatible properties

• text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the text font.

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.histogram.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the sample data to be binned on the x axis.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xbins – plotly.graph_objects.histogram.XBins instance or dict with compatible properties

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the sample data to be binned on the y axis.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ybins – plotly.graph_objects.histogram.YBins instance or dict with compatible properties

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_histogram2d(autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Histogram2d trace

The sample data from which statistics are computed is set in x and y (where x and y represent marginal distributions, binning is set in xbins and ybins in this case) or z (where z represent the 2D distribution and binning set, binning is set by x and y in this case). The resulting distribution is visualized as a heatmap.

Parameters

• autobinx – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

• autobiny – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

• bingroup – Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.histogram2d.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

• histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.histogram2d.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.histogram2d.Legendgrouptit le instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.histogram2d.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• nbinsx – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

• nbinsy – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.histogram2d.Stream instance or dict with compatible properties

• textfont – Sets the text font.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the sample data to be binned on the x axis.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xbingroup – Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

• xbins – plotly.graph_objects.histogram2d.XBins instance or dict with compatible properties

• xcalendar – Sets the calendar system to use with x date data.

• xgap – Sets the horizontal gap (in pixels) between bricks.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the sample data to be binned on the y axis.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ybingroup – Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

• ybins – plotly.graph_objects.histogram2d.YBins instance or dict with compatible properties

• ycalendar – Sets the calendar system to use with y date data.

• ygap – Sets the vertical gap (in pixels) between bricks.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the aggregation data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsmooth – Picks a smoothing algorithm use to smooth z data.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_histogram2dcontour(autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Histogram2dContour trace

The sample data from which statistics are computed is set in x and y (where x and y represent marginal distributions, binning is set in xbins and ybins in this case) or z (where z represent the 2D distribution and binning set, binning is set by x and y in this case). The resulting distribution is visualized as a contour plot.

Parameters

• autobinx – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

• autobiny – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

• autocontour – Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in ncontours. If False, set the contour level attributes in contours.

• bingroup – Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.histogram2dcontour.ColorBa r instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contours – plotly.graph_objects.histogram2dcontour.Contour s instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

• histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.histogram2dcontour.Hoverla bel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.histogram2dcontour.Legendg rouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.histogram2dcontour.Line instance or dict with compatible properties

• marker – plotly.graph_objects.histogram2dcontour.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• nbinsx – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

• nbinsy – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

• ncontours – Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is True or if contours.size is missing.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.histogram2dcontour.Stream instance or dict with compatible properties

• textfont – For this trace it only has an effect if coloring is set to “heatmap”. Sets the text font.

• texttemplate – For this trace it only has an effect if coloring is set to “heatmap”. Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the sample data to be binned on the x axis.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xbingroup – Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

• xbins – plotly.graph_objects.histogram2dcontour.XBins instance or dict with compatible properties

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the sample data to be binned on the y axis.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ybingroup – Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

• ybins – plotly.graph_objects.histogram2dcontour.YBins instance or dict with compatible properties

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the aggregation data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_hline(y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a horizontal line to a plot or subplot that extends infinitely in the x-dimension.

Parameters

• y (float or int) – A number representing the y coordinate of the horizontal line.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the line. Example positions are “bottom left”, “right top”, “right”, “bottom”. If an annotation is added but annotation_position is not specified, this defaults to “top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_hrect(y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a rectangle to a plot or subplot that extends infinitely in the x-dimension.

Parameters

• y0 (float or int) – A number representing the y coordinate of one side of the rectangle.

• y1 (float or int) – A number representing the y coordinate of the other side of the rectangle.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["inside", "outside"], ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the rectangle. Example positions are “outside top left”, “inside bottom”, “right”, “inside left”, “inside” (“outside” is not supported). If an annotation is added but annotation_position is not specified this defaults to “inside top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_icicle(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Icicle trace

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The icicle sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

• branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

• count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.icicle.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.icicle.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• labels – Sets the labels of each of the sectors.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• leaf – plotly.graph_objects.icicle.Leaf instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.icicle.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

• marker – plotly.graph_objects.icicle.Marker instance or dict with compatible properties

• maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

• parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

• parentssrc – Sets the source reference on Chart Studio Cloud for parents.

• pathbar – plotly.graph_objects.icicle.Pathbar instance or dict with compatible properties

• root – plotly.graph_objects.icicle.Root instance or dict with compatible properties

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.icicle.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Sets the positions of the text elements.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• tiling – plotly.graph_objects.icicle.Tiling instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_image(colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Image trace

Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. autorange: 'reversed'), constrained to the domain (ie. constrain: 'domain') and it will have the same scale as its x axis (ie. scaleanchor: 'x,) in order for pixels to be rendered as squares.

Parameters

• colormodel – Color model used to map the numerical color components described in z into colors. If source is specified, this attribute will be set to rgba256 otherwise it defaults to rgb.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Set the pixel’s horizontal size.

• dy – Set the pixel’s vertical size

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.image.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables z, color and colormodel. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.image.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• source – Specifies the data URI of the image to be visualized. The URI consists of “data:image/[<media subtype>][;base64],<data>”

• stream – plotly.graph_objects.image.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x0 – Set the image’s x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• y0 – Set the image’s y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• z – A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

• zmax – Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the rgb colormodel, it is [255, 255, 255]. For the rgba colormodel, it is [255, 255, 255, 1]. For the rgba256 colormodel, it is [255, 255, 255, 255]. For the hsl colormodel, it is [360, 100, 100]. For the hsla colormodel, it is [360, 100, 100, 1].

• zmin – Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the rgb colormodel, it is [0, 0, 0]. For the rgba colormodel, it is [0, 0, 0, 0]. For the rgba256 colormodel, it is [0, 0, 0, 0]. For the hsl colormodel, it is [0, 0, 0]. For the hsla colormodel, it is [0, 0, 0, 0].

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsmooth – Picks a smoothing algorithm used to smooth z data. This only applies for image traces that use the source attribute.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_indicator(align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Indicator trace

An indicator is used to visualize a single value along with some contextual information such as steps or a threshold, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a reference. Gauges can be either angular or bullet (aka linear) gauges.

Parameters

• align – Sets the horizontal alignment of the text within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• delta – plotly.graph_objects.indicator.Delta instance or dict with compatible properties

• domain – plotly.graph_objects.indicator.Domain instance or dict with compatible properties

• gauge – The gauge of the Indicator plot.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – :class:`plotly.graph_objects.indicator.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines how the value is displayed on the graph. number displays the value numerically in text. delta displays the difference to a reference value in text. Finally, gauge displays the value graphically on an axis.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• number – plotly.graph_objects.indicator.Number instance or dict with compatible properties

• stream – plotly.graph_objects.indicator.Stream instance or dict with compatible properties

• title – plotly.graph_objects.indicator.Title instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• value – Sets the number to be displayed.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_isosurface(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Isosurface trace

Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the value, x, y and z of every vertex of a uniform or non- uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace.

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.

• caps – plotly.graph_objects.isosurface.Caps instance or dict with compatible properties

• cauto – Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as value and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.isosurface.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contour – plotly.graph_objects.isosurface.Contour instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.isosurface.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• isomax – Sets the maximum boundary for iso-surface plot.

• isomin – Sets the minimum boundary for iso-surface plot.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.isosurface.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.isosurface.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.isosurface.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• slices – plotly.graph_objects.isosurface.Slices instance or dict with compatible properties

• spaceframe – plotly.graph_objects.isosurface.Spaceframe instance or dict with compatible properties

• stream – plotly.graph_objects.isosurface.Stream instance or dict with compatible properties

• surface – plotly.graph_objects.isosurface.Surface instance or dict with compatible properties

• text – Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• value – Sets the 4th dimension (value) of the vertices.

• valuehoverformat – Sets the hover text formatting rulefor value using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• valuesrc – Sets the source reference on Chart Studio Cloud for value.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the X coordinates of the vertices on X axis.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the Y coordinates of the vertices on Y axis.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the Z coordinates of the vertices on Z axis.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_layout_image(arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure

Create and add a new image to the figure’s layout

Parameters

• arg – instance of Image or dict with compatible properties

• layer – Specifies whether images are drawn below or above traces. When xref and yref are both set to paper, image is drawn below the entire plot area.

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the image.

• sizex – Sets the image container size horizontally. The image will be sized based on the position value. When xref is set to paper, units are sized relative to the plot width. When xref ends with ` domain`, units are sized relative to the axis width.

• sizey – Sets the image container size vertically. The image will be sized based on the position value. When yref is set to paper, units are sized relative to the plot height. When yref ends with ` domain`, units are sized relative to the axis height.

• sizing – Specifies which dimension of the image to constrain.

• source – Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• visible – Determines whether or not this image is visible.

• x – Sets the image’s x position. When xref is set to paper, units are sized relative to the plot height. See xref for more info

• xanchor – Sets the anchor for the x position

• xref – Sets the images’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• y – Sets the image’s y position. When yref is set to paper, units are sized relative to the plot height. See yref for more info

• yanchor – Sets the anchor for the y position.

• yref – Sets the images’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• row – Subplot row for image. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for image. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add image to secondary y-axis

• exclude_empty_subplots – If True, image will not be added to subplots without traces.

Returns

Return type

Figure

add_mesh3d(alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Mesh3d trace

Draws sets of triangles with coordinates given by three 1-dimensional arrays in x, y, z and (1) a sets of i, j, k indices (2) Delaunay triangulation or (3) the Alpha- shape algorithm or (4) the Convex-hull algorithm

Parameters

• alphahull – Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the x, y and z arrays, if the i, j, k arrays are not supplied. For general use of mesh3d it is preferred that i, j, k are supplied. If “-1”, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to delaunayaxis. In case the delaunayaxis intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of delaunayaxis. If “>0”, the alpha-shape algorithm is used. In this case, the positive alphahull value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the x, y and z point set into a convex hull.

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

• cauto – Determines whether or not the color domain is computed with respect to the input data (here intensity) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as intensity and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as intensity and if set, cmax must be set as well.

• color – Sets the color of the whole mesh

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.mesh3d.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contour – plotly.graph_objects.mesh3d.Contour instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• delaunayaxis – Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if i, j, k are not provided and alphahull is set to indicate Delaunay triangulation.

• facecolor – Sets the color of each face Overrides “color” and “vertexcolor”.

• facecolorsrc – Sets the source reference on Chart Studio Cloud for facecolor.

• flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.mesh3d.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• i – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “first” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where i[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in i represents a point in space, which is the first vertex of a triangle.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• intensity – Sets the intensity values for vertices or cells as defined by intensitymode. It can be used for plotting fields on meshes.

• intensitymode – Determines the source of intensity values.

• intensitysrc – Sets the source reference on Chart Studio Cloud for intensity.

• isrc – Sets the source reference on Chart Studio Cloud for i.

• j – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “second” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where j[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in j represents a point in space, which is the second vertex of a triangle.

• jsrc – Sets the source reference on Chart Studio Cloud for j.

• k – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “third” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where k[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in k represents a point in space, which is the third vertex of a triangle.

• ksrc – Sets the source reference on Chart Studio Cloud for k.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.mesh3d.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.mesh3d.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.mesh3d.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.mesh3d.Stream instance or dict with compatible properties

• text – Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• vertexcolor – Sets the color of each vertex Overrides “color”. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.

• vertexcolorsrc – Sets the source reference on Chart Studio Cloud for vertexcolor.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the X coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the Y coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the Z coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

• zcalendar – Sets the calendar system to use with z date data.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_ohlc(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Ohlc trace

The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given x coordinate (most likely time). The tip of the lines represent the low and high values and the horizontal segments represent the open and close values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red.

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.ohlc.Decreasing instance or dict with compatible properties

• high – Sets the high values.

• highsrc – Sets the source reference on Chart Studio Cloud for high.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.ohlc.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables open, high, low and close. 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• increasing – plotly.graph_objects.ohlc.Increasing instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.ohlc.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.ohlc.Line instance or dict with compatible properties

• low – Sets the low values.

• lowsrc – Sets the source reference on Chart Studio Cloud for low.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• open – Sets the open values.

• opensrc – Sets the source reference on Chart Studio Cloud for open.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.ohlc.Stream instance or dict with compatible properties

• text – Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• tickwidth – Sets the width of the open/close tick marks relative to the “x” minimal interval.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates. If absent, linear coordinate will be generated.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_parcats(arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Parcats trace

Parallel categories diagram for multidimensional categorical data.

Parameters

• arrangement – Sets the drag interaction mode for categories and dimensions. If perpendicular, the categories can only move along a line perpendicular to the paths. If freeform, the categories can freely move on the plane. If fixed, the categories and dimensions are stationary.

• bundlecolors – Sort paths so that like colors are bundled together within each category.

• counts – The number of observations represented by each state. Defaults to 1 so that each state represents one observation

• countssrc – Sets the source reference on Chart Studio Cloud for counts.

• dimensions – The dimensions (variables) of the parallel categories diagram.

• dimensiondefaults – When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions

• domain – plotly.graph_objects.parcats.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoveron – Sets the hover interaction mode for the parcats diagram. If category, hover interaction take place per category. If color, hover interactions take place per color per category. If dimension, hover interactions take place across all categories per dimension.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables count, probability, category, categorycount, colorcount and bandcolorcount. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• labelfont – Sets the font for the dimension labels.

• legendgrouptitle – plotly.graph_objects.parcats.Legendgrouptitle instance or dict with compatible properties

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.parcats.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• sortpaths – Sets the path sorting algorithm. If forward, sort paths based on dimension categories from left to right. If backward, sort paths based on dimensions categories from right to left.

• stream – plotly.graph_objects.parcats.Stream instance or dict with compatible properties

• tickfont – Sets the font for the category labels.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_parcoords(customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Parcoords trace

Parallel coordinates for multidimensional exploratory data analysis. The samples are specified in dimensions. The colors are set in line.color.

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.

• dimensions – The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.

• dimensiondefaults – When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions

• domain – plotly.graph_objects.parcoords.Domain instance or dict with compatible properties

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• labelangle – Sets the angle of the labels with respect to the horizontal. For example, a tickangle of -90 draws the labels vertically. Tilted labels with “labelangle” may be positioned better inside margins when labelposition is set to “bottom”.

• labelfont – Sets the font for the dimension labels.

• labelside – Specifies the location of the label. “top” positions labels above, next to the title “bottom” positions labels below the graph Tilted labels with “labelangle” may be positioned better inside margins when labelposition is set to “bottom”.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – :class:`plotly.graph_objects.parcoords.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.parcoords.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• rangefont – Sets the font for the dimension range values.

• stream – plotly.graph_objects.parcoords.Stream instance or dict with compatible properties

• tickfont – Sets the font for the dimension tick values.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.parcoords.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_pie(automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Pie trace

A data visualized by the sectors of the pie is set in values. The sector labels are set in labels. The sector colors are set in marker.colors

Parameters

• automargin – Determines whether outside text labels can push the margins.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• direction – Specifies the direction at which succeeding sectors follow one another.

• dlabel – Sets the label step. See label0 for more info.

• domain – plotly.graph_objects.pie.Domain instance or dict with compatible properties

• hole – Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.pie.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• insidetextorientation – Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.

• label0 – Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

• labels – Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.pie.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.pie.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector.

• pull – Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

• pullsrc – Sets the source reference on Chart Studio Cloud for pull.

• rotation – Instead of the first slice starting at 12 o’clock, rotate to some other angle.

• scalegroup – If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.pie.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Specifies the location of the textinfo.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• title – plotly.graph_objects.pie.Title instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values of the sectors. If omitted, we count occurrences of each label.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_sankey(arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Sankey trace

Sankey plots for network flow data analysis. The nodes are specified in nodes and the links between sources and targets in links. The colors are set in nodes[i].color and links[i].color, otherwise defaults are used.

Parameters

• arrangement – If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad. If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.sankey.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

• hoverlabel – plotly.graph_objects.sankey.Hoverlabel instance or dict with compatible properties

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.sankey.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• link – The links of the Sankey plot.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• node – The nodes of the Sankey plot.

• orientation – Sets the orientation of the Sankey diagram.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• stream – plotly.graph_objects.sankey.Stream instance or dict with compatible properties

• textfont – Sets the font for node labels

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• valueformat – Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.

• valuesuffix – Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scatter(alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scatter trace

The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in x and y. Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

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.

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• error_x – plotly.graph_objects.scatter.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.scatter.ErrorY instance or dict with compatible properties

• fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

• fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.

• fillgradient – Sets a fill gradient. If not specified, the fillcolor is used instead.

• fillpattern – Sets the pattern within the marker.

• groupnorm – Only relevant when stackgroup is used, and only the first groupnorm found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the normalization for the sum of this stackgroup. With “fraction”, the value of each trace at each location is divided by the sum of all trace values at that location. “percent” is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatter.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatter.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatter.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatter.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

• orientation – Only relevant in the following cases: 1. when scattermode is set to “group”. 2. when stackgroup is used, and only the first orientation found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the stacking direction. With “v” (“h”), the y (x) values of subsequent traces are added. Also affects the default value of fill.

• selected – plotly.graph_objects.scatter.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stackgaps – Only relevant when stackgroup is used, and only the first stackgaps found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Determines how we handle locations at which other traces in this group have data but this one does not. With infer zero we insert a zero at these locations. With “interpolate” we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

• stackgroup – Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if orientation is “h”). If blank or omitted this trace will not be stacked. Stacking also turns fill on by default, using “tonexty” (“tonextx”) if orientation is “h” (“v”) and sets the default mode to “lines” irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

• stream – plotly.graph_objects.scatter.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatter.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_scatter3d(connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scatter3d trace

The data visualized as scatter point or lines in 3D dimension is set in x, y, z. Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color Projections are achieved via projection. Surface fills are achieved via surfaceaxis.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• error_x – plotly.graph_objects.scatter3d.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.scatter3d.ErrorY instance or dict with compatible properties

• error_z – plotly.graph_objects.scatter3d.ErrorZ instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatter3d.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y,z) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.scatter3d.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatter3d.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatter3d.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• projection – plotly.graph_objects.scatter3d.Projection instance or dict with compatible properties

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatter3d.Stream instance or dict with compatible properties

• surfaceaxis – If “-1”, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

• surfacecolor – Sets the surface fill color.

• text – Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y,z) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates.

• zcalendar – Sets the calendar system to use with z date data.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scattercarpet(a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scattercarpet trace

Plots a scatter trace on either the first carpet axis or the carpet axis with a matching carpet attribute.

Parameters

• a – Sets the a-axis coordinates.

• asrc – Sets the source reference on Chart Studio Cloud for a.

• b – Sets the b-axis coordinates.

• bsrc – Sets the source reference on Chart Studio Cloud for b.

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

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattercarpet.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattercarpet.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattercarpet.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scattercarpet.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattercarpet.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattercarpet.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattercarpet.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_scattergeo(connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scattergeo trace

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in lon and lat respectively or by geographic location IDs or names in locations.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example “properties.name”.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

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

• geo – Sets a reference between this trace’s geospatial coordinates and a geographic map. If “geo” (the default value), the geospatial coordinates refer to layout.geo. If “geo2”, the geospatial coordinates refer to layout.geo2, and so on.

• geojson – Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when locations is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattergeo.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattergeo.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattergeo.Line instance or dict with compatible properties

• locationmode – The library used by the country names locationmode option is changing in an upcoming version. Country names in existing plots may not work in the new version. Determines the set of locations used to match entries in locations to regions on the map. Values “ISO-3”, “USA-states”, country names correspond to features on the base map and value “geojson-id” corresponds to features from a custom GeoJSON linked to the geojson attribute.

• locations – Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See locationmode for more info.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• marker – plotly.graph_objects.scattergeo.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattergeo.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattergeo.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon, location and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattergeo.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scattergl(connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scattergl trace

The data visualized as scatter point or lines is set in x and y using the WebGL plotting engine. Bubble charts are achieved by setting marker.size and/or marker.color to a numerical arrays.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• error_x – plotly.graph_objects.scattergl.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.scattergl.ErrorY instance or dict with compatible properties

• fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattergl.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.scattergl.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattergl.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scattergl.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattergl.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattergl.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattergl.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_scattermap(below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scattermap trace

The data visualized as scatter point, lines or marker symbols on a MapLibre GL geographic map is provided by longitude/latitude pairs in lon and lat.

Parameters

• below – Determines if this scattermap trace’s layers are to be inserted before the layer with the specified ID. By default, scattermap layers are inserted above all the base layers. To place the scattermap layers above every other layer, set below to “’’”.

• cluster – plotly.graph_objects.scattermap.Cluster instance or dict with compatible properties

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattermap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattermap.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattermap.Line instance or dict with compatible properties

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• marker – plotly.graph_objects.scattermap.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattermap.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattermap.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the icon text font (color=map.layer.paint.text- color, size=map.layer.layout.text-size). Has an effect only when type is set to “symbol”.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattermap.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scattermapbox(below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scattermapbox trace

“scattermapbox” trace is deprecated! Please consider switching to the “scattermap” trace type and map subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ The data visualized as scatter point, lines or marker symbols on a Mapbox GL geographic map is provided by longitude/latitude pairs in lon and lat.

Parameters

• below – Determines if this scattermapbox trace’s layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set below to “’’”.

• cluster – plotly.graph_objects.scattermapbox.Cluster instance or dict with compatible properties

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattermapbox.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattermapbox.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattermapbox.Line instance or dict with compatible properties

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• marker – plotly.graph_objects.scattermapbox.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattermapbox.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattermapbox.Stream instance or dict with compatible properties

• subplot – mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre- migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the icon text font (color=mapbox.layer.paint.text- color, size=mapbox.layer.layout.text-size). Has an effect only when type is set to “symbol”.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattermapbox.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scatterpolar(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scatterpolar trace

The scatterpolar trace type encompasses line charts, scatter charts, text charts, and bubble charts in polar coordinates. The data visualized as scatter point or lines is set in r (radial) and theta (angular) coordinates Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dr – Sets the r coordinate step.

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

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterpolar has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatterpolar.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatterpolar.Legendgroupti tle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatterpolar.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatterpolar.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• r – Sets the radial coordinates

• r0 – Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

• rsrc – Sets the source reference on Chart Studio Cloud for r.

• selected – plotly.graph_objects.scatterpolar.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatterpolar.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a polar subplot. If “polar” (the default value), the data refer to layout.polar. If “polar2”, the data refer to layout.polar2, and so on.

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• theta – Sets the angular coordinates

• theta0 – Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

• thetasrc – Sets the source reference on Chart Studio Cloud for theta.

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

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatterpolar.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scatterpolargl(connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scatterpolargl trace

The scatterpolargl trace type encompasses line charts, scatter charts, and bubble charts in polar coordinates using the WebGL plotting engine. The data visualized as scatter point or lines is set in r (radial) and theta (angular) coordinates Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dr – Sets the r coordinate step.

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

• fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatterpolargl.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatterpolargl.Legendgroup title instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatterpolargl.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatterpolargl.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• r – Sets the radial coordinates

• r0 – Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

• rsrc – Sets the source reference on Chart Studio Cloud for r.

• selected – plotly.graph_objects.scatterpolargl.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatterpolargl.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a polar subplot. If “polar” (the default value), the data refer to layout.polar. If “polar2”, the data refer to layout.polar2, and so on.

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• theta – Sets the angular coordinates

• theta0 – Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

• thetasrc – Sets the source reference on Chart Studio Cloud for theta.

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

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatterpolargl.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scattersmith(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scattersmith trace

The scattersmith trace type encompasses line charts, scatter charts, text charts, and bubble charts in smith coordinates. The data visualized as scatter point or lines is set in real and imag (imaginary) coordinates Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scattersmith has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattersmith.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• imag – Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

• imagsrc – Sets the source reference on Chart Studio Cloud for imag.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattersmith.Legendgroupti tle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattersmith.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scattersmith.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• real – Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

• realsrc – Sets the source reference on Chart Studio Cloud for real.

• selected – plotly.graph_objects.scattersmith.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattersmith.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a smith subplot. If “smith” (the default value), the data refer to layout.smith. If “smith2”, the data refer to layout.smith2, and so on.

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables real, imag and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattersmith.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_scatterternary(a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Scatterternary trace

Provides similar functionality to the “scatter” type but on a ternary phase diagram. The data is provided by at least two arrays out of a, b, c triplets.

Parameters

• a – Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

• asrc – Sets the source reference on Chart Studio Cloud for a.

• b – Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

• bsrc – Sets the source reference on Chart Studio Cloud for b.

• c – Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• csrc – Sets the source reference on Chart Studio Cloud for c.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatterternary.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatterternary.Legendgroup title instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatterternary.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatterternary.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scatterternary.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatterternary.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a ternary subplot. If “ternary” (the default value), the data refer to layout.ternary. If “ternary2”, the data refer to layout.ternary2, and so on.

• sum – The number each triplet should sum to, if only two of a, b, and c are provided. This overrides ternary<i>.sum to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sum

• text – Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b, c and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatterternary.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_selection(arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure

Create and add a new selection to the figure’s layout

Parameters

• arg – instance of Selection or dict with compatible properties

• line – plotly.graph_objects.layout.selection.Line instance or dict with compatible properties

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the selection.

• path – For type “path” - a valid SVG path similar to shapes.path in data coordinates. Allowed segments are: M, L and Z.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• type – Specifies the selection type to be drawn. If “rect”, a rectangle is drawn linking (x0,`y0`), (x1,`y0`), (x1,`y1`) and (x0,`y1`). If “path”, draw a custom SVG path using path.

• x0 – Sets the selection’s starting x position.

• x1 – Sets the selection’s end x position.

• xref – Sets the selection’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• y0 – Sets the selection’s starting y position.

• y1 – Sets the selection’s end y position.

• yref – Sets the selection’s x coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• row – Subplot row for selection. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for selection. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add selection to secondary y-axis

• exclude_empty_subplots – If True, selection will not be added to subplots without traces.

Returns

Return type

Figure

add_shape(arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figure.Figure

Create and add a new shape to the figure’s layout

Parameters

• arg – instance of Shape or dict with compatible properties

• editable – Determines whether the shape could be activated for edit or not. Has no effect when the older editable shapes mode is enabled via config.editable or config.edits.shapePosition.

• fillcolor – Sets the color filling the shape’s interior. Only applies to closed shapes.

• fillrule – Determines which regions of complex paths constitute the interior. For more info please visit https://developer.mozilla.org/en- US/docs/Web/SVG/Attribute/fill-rule

• label – plotly.graph_objects.layout.shape.Label instance or dict with compatible properties

• layer – Specifies whether shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).

• legend – Sets the reference to a legend to show this shape in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgroup – Sets the legend group for this shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

• legendgrouptitle – plotly.graph_objects.layout.shape.Legendgroupti tle instance or dict with compatible properties

• legendrank – Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this shape.

• line – plotly.graph_objects.layout.shape.Line instance or dict with compatible properties

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the shape.

• path – For type “path” - a valid SVG path with the pixel values replaced by data values in xsizemode/ysizemode being “scaled” and taken unmodified as pixels relative to xanchor and yanchor in case of “pixel” size mode. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained “polybezier” commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can’t use either to separate date from time parts. Therefore we’ll use underscore for this purpose: 2015-02-21_13:45:56.789

• showlegend – Determines whether or not this shape is shown in the legend.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• type – Specifies the shape type to be drawn. If “line”, a line is drawn from (x0,`y0`) to (x1,`y1`) with respect to the axes’ sizing mode. If “circle”, a circle is drawn from ((x0`+`x1)/2, (y0`+`y1)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes’ sizing mode. If “rect”, a rectangle is drawn linking (x0,`y0`), (x1,`y0`), (x1,`y1`), (x0,`y1`), (x0,`y0`) with respect to the axes’ sizing mode. If “path”, draw a custom SVG path using path. with respect to the axes’ sizing mode.

• visible – Determines whether or not this shape is visible. If “legendonly”, the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x0 – Sets the shape’s starting x position. See type and xsizemode for more info.

• x0shift – Shifts x0 away from the center of the category when xref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• x1 – Sets the shape’s end x position. See type and xsizemode for more info.

• x1shift – Shifts x1 away from the center of the category when xref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• xanchor – Only relevant in conjunction with xsizemode set to “pixel”. Specifies the anchor point on the x axis to which x0, x1 and x coordinates within path are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when xsizemode not set to “pixel”.

• xref – Sets the shape’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• xsizemode – Sets the shapes’s sizing mode along the x axis. If set to “scaled”, x0, x1 and x coordinates within path refer to data values on the x axis or a fraction of the plot area’s width (xref set to “paper”). If set to “pixel”, xanchor specifies the x position in terms of data or plot fraction but x0, x1 and x coordinates within path are pixels relative to xanchor. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.

• y0 – Sets the shape’s starting y position. See type and ysizemode for more info.

• y0shift – Shifts y0 away from the center of the category when yref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• y1 – Sets the shape’s end y position. See type and ysizemode for more info.

• y1shift – Shifts y1 away from the center of the category when yref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• yanchor – Only relevant in conjunction with ysizemode set to “pixel”. Specifies the anchor point on the y axis to which y0, y1 and y coordinates within path are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when ysizemode not set to “pixel”.

• yref – Sets the shape’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• ysizemode – Sets the shapes’s sizing mode along the y axis. If set to “scaled”, y0, y1 and y coordinates within path refer to data values on the y axis or a fraction of the plot area’s height (yref set to “paper”). If set to “pixel”, yanchor specifies the y position in terms of data or plot fraction but y0, y1 and y coordinates within path are pixels relative to yanchor. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.

• row – Subplot row for shape. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for shape. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add shape to secondary y-axis

• exclude_empty_subplots – If True, shape will not be added to subplots without traces.

Returns

Return type

Figure

add_splom(customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Splom trace

Splom traces generate scatter plot matrix visualizations. Each splom dimensions items correspond to a generated axis. Values for each of those dimensions are set in dimensions[i].values. Splom traces support all scattergl marker style attributes. Specify layout.grid attributes and/or layout x-axis and y-axis attributes for more control over the axis positioning and style.

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.

• diagonal – plotly.graph_objects.splom.Diagonal instance or dict with compatible properties

• dimensions – A tuple of plotly.graph_objects.splom.Dimension instances or dicts with compatible properties

• dimensiondefaults – When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.splom.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.splom.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.splom.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.splom.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showlowerhalf – Determines whether or not subplots on the lower half from the diagonal are displayed.

• showupperhalf – Determines whether or not subplots on the upper half from the diagonal are displayed.

• stream – plotly.graph_objects.splom.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.splom.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• xaxes – Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• yaxes – Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_streamtube(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Streamtube trace

Use a streamtube trace to visualize flow in a vector field. Specify a vector field using 6 1D arrays of equal length, 3 position arrays x, y and z and 3 vector component arrays u, v, and w. By default, the tubes’ starting positions will be cut from the vector field’s x-z plane at its minimum y value. To specify your own starting position, use attributes starts.x, starts.y and starts.z. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w).

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.

• cauto – Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.streamtube.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.streamtube.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables tubex, tubey, tubez, tubeu, tubev, tubew, norm and divergence. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.streamtube.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.streamtube.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.streamtube.Lightposition instance or dict with compatible properties

• maxdisplayed – The maximum number of displayed segments in a streamtube.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• sizeref – The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.

• starts – plotly.graph_objects.streamtube.Starts instance or dict with compatible properties

• stream – plotly.graph_objects.streamtube.Stream instance or dict with compatible properties

• text – Sets a text element associated with this trace. If trace hoverinfo contains a “text” flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array text values.

• u – Sets the x components of the vector field.

• uhoverformat – Sets the hover text formatting rulefor u using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• usrc – Sets the source reference on Chart Studio Cloud for u.

• v – Sets the y components of the vector field.

• vhoverformat – Sets the hover text formatting rulefor v using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• vsrc – Sets the source reference on Chart Studio Cloud for v.

• w – Sets the z components of the vector field.

• whoverformat – Sets the hover text formatting rulefor w using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• wsrc – Sets the source reference on Chart Studio Cloud for w.

• x – Sets the x coordinates of the vector field.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates of the vector field.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates of the vector field.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_sunburst(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Sunburst trace

Visualize hierarchal data spanning outward radially from root to leaves. The sunburst sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

• branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

• count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.sunburst.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.sunburst.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• insidetextorientation – Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.

• labels – Sets the labels of each of the sectors.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• leaf – plotly.graph_objects.sunburst.Leaf instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.sunburst.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

• marker – plotly.graph_objects.sunburst.Marker instance or dict with compatible properties

• maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

• parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

• parentssrc – Sets the source reference on Chart Studio Cloud for parents.

• root – plotly.graph_objects.sunburst.Root instance or dict with compatible properties

• rotation – Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o’clock.

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.sunburst.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_surface(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Surface trace

The data the describes the coordinates of the surface is set in z. Data in z should be a 2D list. Coordinates in x and y can either be 1D lists or 2D lists (e.g. to graph parametric surfaces). If not provided in x and y, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the z values by default. For custom color scales, use surfacecolor which should be a 2D list, where its bounds can be controlled using cmin and cmax.

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.

• cauto – Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmin must be set as well.

• cmid – Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when cauto is false.

• cmin – Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.surface.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in.

• contours – plotly.graph_objects.surface.Contours instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hidesurface – Determines whether or not a surface is drawn. For example, set hidesurface to False contours.x.show to True and contours.y.show to True to draw a wire frame plot.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.surface.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.surface.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.surface.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.surface.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

• opacityscale – Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The default is ‘uniform’.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.surface.Stream instance or dict with compatible properties

• surfacecolor – Sets the surface color values, used for setting a color scale independent of z.

• surfacecolorsrc – Sets the source reference on Chart Studio Cloud for surfacecolor.

• text – Sets the text elements associated with each z value. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates.

• zcalendar – Sets the calendar system to use with z date data.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_table(cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Table trace

Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column- major order, ie. the grid is represented as a vector of column vectors.

Parameters

• cells – plotly.graph_objects.table.Cells instance or dict with compatible properties

• columnorder – Specifies the rendered order of the data columns; for example, a value 2 at position 0 means that column index 0 in the data will be rendered as the third column, as columns have an index base of zero.

• columnordersrc – Sets the source reference on Chart Studio Cloud for columnorder.

• columnwidth – The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

• columnwidthsrc – Sets the source reference on Chart Studio Cloud for columnwidth.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.table.Domain instance or dict with compatible properties

• header – plotly.graph_objects.table.Header instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.table.Hoverlabel instance or dict with compatible properties

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.table.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• stream – plotly.graph_objects.table.Stream instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_trace(trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) → plotly.graph_objects._figure.Figure

Add a trace to the figure

Parameters

• trace (BaseTraceType or dict) –

  Either:

  • An instances of a trace classe from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar)

  • or a dicts where:

    • The ‘type’ property specifies the trace type (e.g. ‘scatter’, ‘bar’, ‘area’, etc.). If the dict has no ‘type’ property then ‘scatter’ is assumed.

    • All remaining properties are passed to the constructor of the specified trace type.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots. If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots. If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

  • The trace argument is a 2D cartesian trace (scatter, bar, etc.)

• exclude_empty_subplots (boolean) – If True, the trace will not be added to subplots that don’t already have traces.

Returns

The Figure that add_trace was called on

Return type

BaseFigure

Examples

>>> from plotly import subplots
>>> import plotly.graph_objects as go

Add two Scatter traces to a figure

>>> fig = go.Figure()
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) 
Figure(...)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) 
Figure(...)

Add two Scatter traces to vertically stacked subplots

>>> fig = subplots.make_subplots(rows=2)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) 
Figure(...)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) 
Figure(...)

add_traces(data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) → plotly.graph_objects._figure.Figure

Add traces to the figure

Parameters

• data (list[BaseTraceType or dict]) –

  A list of trace specifications to be added. Trace specifications may be either:

  • Instances of trace classes from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar)

  • Dicts where:

    • The ‘type’ property specifies the trace type (e.g. ‘scatter’, ‘bar’, ‘area’, etc.). If the dict has no ‘type’ property then ‘scatter’ is assumed.

    • All remaining properties are passed to the constructor of the specified trace type.

• rows (None, list[int], or int (default None)) – List of subplot row indexes (starting from 1) for the traces to be added. Only valid if figure was created using plotly.tools.make_subplots If a single integer is passed, all traces will be added to row number

• cols (None or list[int] (default None)) – List of subplot column indexes (starting from 1) for the traces to be added. Only valid if figure was created using plotly.tools.make_subplots If a single integer is passed, all traces will be added to column number

secondary_ys: None or list[boolean] (default None)

List of secondary_y booleans for traces to be added. See the docstring for add_trace for more info.

exclude_empty_subplots: boolean

If True, the trace will not be added to subplots that don’t already have traces.

Returns

The Figure that add_traces was called on

Return type

BaseFigure

Examples

>>> from plotly import subplots
>>> import plotly.graph_objects as go

Add two Scatter traces to a figure

>>> fig = go.Figure()
>>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
...                 go.Scatter(x=[1,2,3], y=[2,1,2])]) 
Figure(...)

Add two Scatter traces to vertically stacked subplots

>>> fig = subplots.make_subplots(rows=2)
>>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
...                 go.Scatter(x=[1,2,3], y=[2,1,2])],
...                 rows=[1, 2], cols=[1, 1]) 
Figure(...)

add_treemap(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Treemap trace

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The treemap sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

• branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

• count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.treemap.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.treemap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• labels – Sets the labels of each of the sectors.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.treemap.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

• marker – plotly.graph_objects.treemap.Marker instance or dict with compatible properties

• maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

• parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

• parentssrc – Sets the source reference on Chart Studio Cloud for parents.

• pathbar – plotly.graph_objects.treemap.Pathbar instance or dict with compatible properties

• root – plotly.graph_objects.treemap.Root instance or dict with compatible properties

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.treemap.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Sets the positions of the text elements.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• tiling – plotly.graph_objects.treemap.Tiling instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_violin(alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Violin trace

In vertical (horizontal) violin plots, statistics are computed using y (x) values. By supplying an x (y) array, one violin per distinct x (y) value is drawn If no x (y) list is provided, a single violin is drawn. That violin position is then positioned with with name or with x0 (y0) if provided.

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.

• bandwidth – Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman’s rule of thumb.

• box – plotly.graph_objects.violin.Box instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.violin.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• jitter – Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.violin.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.violin.Line instance or dict with compatible properties

• marker – plotly.graph_objects.violin.Marker instance or dict with compatible properties

• meanline – plotly.graph_objects.violin.Meanline instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute scalegroup (please see its description for details).

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

• orientation – Sets the orientation of the violin(s). If “v” (“h”), the distribution is visualized along the vertical (horizontal).

• pointpos – Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

• points – If “outliers”, only the sample points lying outside the whiskers are shown If “suspectedoutliers”, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all sample points are shown If False, only the violins are shown with no sample points. Defaults to “suspectedoutliers” when marker.outliercolor or marker.line.outliercolor is set, otherwise defaults to “outliers”.

• quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

• scalegroup – If there are multiple violins that should be sized according to to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin’s width is undefined, scalegroup will default to the trace’s name. In this case, violins with the same names will be linked together

• scalemode – Sets the metric by which the width of each violin is determined. “width” means each violin has the same (max) width “count” means the violins are scaled by the number of sample points making up each violin.

• selected – plotly.graph_objects.violin.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• side – Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under “overlay” mode, where one trace has side set to “positive” and the other to “negative”.

• span – Sets the span in data space for which the density function will be computed. Has an effect only when spanmode is set to “manual”.

• spanmode – Sets the method by which the span in data space where the density function will be computed. “soft” means the span goes from the sample’s minimum value minus two bandwidths to the sample’s maximum value plus two bandwidths. “hard” means the span goes from the sample’s minimum to its maximum value. For custom span settings, use mode “manual” and fill in the span attribute.

• stream – plotly.graph_objects.violin.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.violin.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

• x – Sets the x sample data or coordinates. See overview for more info.

• x0 – Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y sample data or coordinates. See overview for more info.

• y0 – Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

add_vline(x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a vertical line to a plot or subplot that extends infinitely in the y-dimension.

Parameters

• x (float or int) – A number representing the x coordinate of the vertical line.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the line. Example positions are “bottom left”, “right top”, “right”, “bottom”. If an annotation is added but annotation_position is not specified, this defaults to “top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_volume(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Volume trace

Draws volume trace between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the value, x, y and z of every vertex of a uniform or non- uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace.

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.

• caps – plotly.graph_objects.volume.Caps instance or dict with compatible properties

• cauto – Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as value and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.volume.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contour – plotly.graph_objects.volume.Contour instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.volume.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• isomax – Sets the maximum boundary for iso-surface plot.

• isomin – Sets the minimum boundary for iso-surface plot.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.volume.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.volume.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.volume.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

• opacityscale – Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The default is ‘uniform’.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• slices – plotly.graph_objects.volume.Slices instance or dict with compatible properties

• spaceframe – plotly.graph_objects.volume.Spaceframe instance or dict with compatible properties

• stream – plotly.graph_objects.volume.Stream instance or dict with compatible properties

• surface – plotly.graph_objects.volume.Surface instance or dict with compatible properties

• text – Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• value – Sets the 4th dimension (value) of the vertices.

• valuehoverformat – Sets the hover text formatting rulefor value using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• valuesrc – Sets the source reference on Chart Studio Cloud for value.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the X coordinates of the vertices on X axis.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the Y coordinates of the vertices on Y axis.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the Z coordinates of the vertices on Z axis.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

Figure

add_vrect(x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a rectangle to a plot or subplot that extends infinitely in the y-dimension.

Parameters

• x0 (float or int) – A number representing the x coordinate of one side of the rectangle.

• x1 (float or int) – A number representing the x coordinate of the other side of the rectangle.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["inside", "outside"], ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the rectangle. Example positions are “outside top left”, “inside bottom”, “right”, “inside left”, “inside” (“outside” is not supported). If an annotation is added but annotation_position is not specified this defaults to “inside top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_waterfall(alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Add a new Waterfall trace

Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in y if orientation is set to “v” (the default) and the labels are set in x. By setting orientation to “h”, the roles are interchanged.

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

• cliponaxis – Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connector – plotly.graph_objects.waterfall.Connector instance or dict with compatible properties

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

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• decreasing – plotly.graph_objects.waterfall.Decreasing instance or dict with compatible properties

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.waterfall.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta and final. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• increasing – plotly.graph_objects.waterfall.Increasing instance or dict with compatible properties

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.waterfall.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• measure – An array containing types of values. By default the values are considered as ‘relative’. However; it is possible to use ‘total’ to compute the sums. Also ‘absolute’ could be applied to reset the computed total or to declare an initial value where needed.

• measuresrc – Sets the source reference on Chart Studio Cloud for measure.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• offsetsrc – Sets the source reference on Chart Studio Cloud for offset.

• opacity – Sets the opacity of the trace.

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

• outsidetextfont – Sets the font used for text lying outside the bar.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.waterfall.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the font used for text.

• textinfo – Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta, final and label.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• totals – plotly.graph_objects.waterfall.Totals instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the bar width (in position axis units).

• widthsrc – Sets the source reference on Chart Studio Cloud for width.

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

Figure

for_each_annotation(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all annotations that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single annotation object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotations that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotations that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select annotations associated with the secondary y-axis of the subplot.

  • If False, only select annotations associated with the primary y-axis of the subplot.

  • If None (the default), do not filter annotations based on secondary y-axis.

  To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_coloraxis(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all coloraxis objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single coloraxis object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_geo(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all geo objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single geo object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_layout_image(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all images that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single image object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those images that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those images that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select images associated with the secondary y-axis of the subplot.

  • If False, only select images associated with the primary y-axis of the subplot.

  • If None (the default), do not filter images based on secondary y-axis.

  To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_legend(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all legend objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single legend object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_map(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all map objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single map object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_mapbox(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all mapbox objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single mapbox object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_polar(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all polar objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single polar object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_scene(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all scene objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single scene object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_selection(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all selections that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single selection object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selections that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selections that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select selections associated with the secondary y-axis of the subplot.

  • If False, only select selections associated with the primary y-axis of the subplot.

  • If None (the default), do not filter selections based on secondary y-axis.

  To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_shape(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all shapes that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single shape object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shapes that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shapes that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select shapes associated with the secondary y-axis of the subplot.

  • If False, only select shapes associated with the primary y-axis of the subplot.

  • If None (the default), do not filter shapes based on secondary y-axis.

  To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_smith(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all smith objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single smith object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_ternary(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all ternary objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single ternary object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_trace(fn, selector=None, row=None, col=None, secondary_y=None) → plotly.graph_objects._figure.Figure

Apply a function to all traces that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single trace object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all traces are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each trace and those for which the function returned True will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• col (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select traces associated with the secondary y-axis of the subplot.

  • If False, only select traces associated with the primary y-axis of the subplot.

  • If None (the default), do not filter traces based on secondary y-axis.

  To select traces by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_xaxis(fn, selector=None, row=None, col=None) → plotly.graph_objects._figure.Figure

Apply a function to all xaxis objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single xaxis object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_yaxis(fn, selector=None, row=None, col=None, secondary_y=None) → plotly.graph_objects._figure.Figure

Apply a function to all yaxis objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single yaxis object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select yaxis objects associated with the secondary y-axis of the subplot.

  • If False, only select yaxis objects associated with the primary y-axis of the subplot.

  • If None (the default), do not filter yaxis objects based on a secondary y-axis condition.

  To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

select_annotations(selector=None, row=None, col=None, secondary_y=None)

Select annotations from a particular subplot cell and/or annotations that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select annotations associated with the secondary y-axis of the subplot.

  • If False, only select annotations associated with the primary y-axis of the subplot.

  • If None (the default), do not filter annotations based on secondary y-axis.

  To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the annotations that satisfy all of the specified selection criteria

Return type

generator

select_coloraxes(selector=None, row=None, col=None)

Select coloraxis subplot objects from a particular subplot cell and/or coloraxis subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

Returns

Generator that iterates through all of the coloraxis objects that satisfy all of the specified selection criteria

Return type

generator

select_geos(selector=None, row=None, col=None)

Select geo subplot objects from a particular subplot cell and/or geo subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

Returns

Generator that iterates through all of the geo objects that satisfy all of the specified selection criteria

Return type

generator

select_layout_images(selector=None, row=None, col=None, secondary_y=None)

Select images from a particular subplot cell and/or images that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select images associated with the secondary y-axis of the subplot.

  • If False, only select images associated with the primary y-axis of the subplot.

  • If None (the default), do not filter images based on secondary y-axis.

  To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the images that satisfy all of the specified selection criteria

Return type

generator

select_legends(selector=None, row=None, col=None)

Select legend subplot objects from a particular subplot cell and/or legend subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

Returns

Generator that iterates through all of the legend objects that satisfy all of the specified selection criteria

Return type

generator

select_mapboxes(selector=None, row=None, col=None)

Select mapbox subplot objects from a particular subplot cell and/or mapbox subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

Returns

Generator that iterates through all of the mapbox objects that satisfy all of the specified selection criteria

Return type

generator

select_maps(selector=None, row=None, col=None)

Select map subplot objects from a particular subplot cell and/or map subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

Returns

Generator that iterates through all of the map objects that satisfy all of the specified selection criteria

Return type

generator

select_polars(selector=None, row=None, col=None)

Select polar subplot objects from a particular subplot cell and/or polar subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

Returns

Generator that iterates through all of the polar objects that satisfy all of the specified selection criteria

Return type

generator

select_scenes(selector=None, row=None, col=None)

Select scene subplot objects from a particular subplot cell and/or scene subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

Returns

Generator that iterates through all of the scene objects that satisfy all of the specified selection criteria

Return type

generator

select_selections(selector=None, row=None, col=None, secondary_y=None)

Select selections from a particular subplot cell and/or selections that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select selections associated with the secondary y-axis of the subplot.

  • If False, only select selections associated with the primary y-axis of the subplot.

  • If None (the default), do not filter selections based on secondary y-axis.

  To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the selections that satisfy all of the specified selection criteria

Return type

generator

select_shapes(selector=None, row=None, col=None, secondary_y=None)

Select shapes from a particular subplot cell and/or shapes that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select shapes associated with the secondary y-axis of the subplot.

  • If False, only select shapes associated with the primary y-axis of the subplot.

  • If None (the default), do not filter shapes based on secondary y-axis.

  To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the shapes that satisfy all of the specified selection criteria

Return type

generator

select_smiths(selector=None, row=None, col=None)

Select smith subplot objects from a particular subplot cell and/or smith subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

Returns

Generator that iterates through all of the smith objects that satisfy all of the specified selection criteria

Return type

generator

select_ternaries(selector=None, row=None, col=None)

Select ternary subplot objects from a particular subplot cell and/or ternary subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

Returns

Generator that iterates through all of the ternary objects that satisfy all of the specified selection criteria

Return type

generator

select_xaxes(selector=None, row=None, col=None)

Select xaxis subplot objects from a particular subplot cell and/or xaxis subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

Returns

Generator that iterates through all of the xaxis objects that satisfy all of the specified selection criteria

Return type

generator

select_yaxes(selector=None, row=None, col=None, secondary_y=None)

Select yaxis subplot objects from a particular subplot cell and/or yaxis subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select yaxis objects associated with the secondary y-axis of the subplot.

  • If False, only select yaxis objects associated with the primary y-axis of the subplot.

  • If None (the default), do not filter yaxis objects based on a secondary y-axis condition.

  To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the yaxis objects that satisfy all of the specified selection criteria

Return type

generator

set_subplots(rows=None, cols=None, **make_subplots_args) → plotly.graph_objects._figure.Figure

Add subplots to this figure. If the figure already contains subplots, then this throws an error. Accepts any keyword arguments that plotly.subplots.make_subplots accepts.

update(dict1=None, overwrite=False, **kwargs) → plotly.graph_objects._figure.Figure

Update the properties of the figure with a dict and/or with keyword arguments.

This recursively updates the structure of the figure object with the values in the input dict / keyword arguments.

Parameters

• dict1 (dict) – Dictionary of properties to be updated

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• kwargs – Keyword/value pair of properties to be updated

Examples

>>> import plotly.graph_objects as go
>>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
>>> fig.update(data=[{'y': [4, 5, 6]}]) 
Figure(...)
>>> fig.to_plotly_json() 
    {'data': [{'type': 'scatter',
       'uid': 'e86a7c7a-346a-11e8-8aa8-a0999b0c017b',
       'y': array([4, 5, 6], dtype=int32)}],
     'layout': {}}

>>> fig = go.Figure(layout={'xaxis':
...                         {'color': 'green',
...                          'range': [0, 1]}})
>>> fig.update({'layout': {'xaxis': {'color': 'pink'}}}) 
Figure(...)
>>> fig.to_plotly_json() 
    {'data': [],
     'layout': {'xaxis':
                {'color': 'pink',
                 'range': [0, 1]}}}

Returns

Updated figure

Return type

BaseFigure

update_annotations(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all annotations that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all annotations that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select annotations associated with the secondary y-axis of the subplot.

  • If False, only select annotations associated with the primary y-axis of the subplot.

  • If None (the default), do not filter annotations based on secondary y-axis.

  To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected annotation. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_coloraxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all coloraxis objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all coloraxis objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• **kwargs – Additional property updates to apply to each selected coloraxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_geos(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all geo objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all geo objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• **kwargs – Additional property updates to apply to each selected geo object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_layout(dict1=None, overwrite=False, **kwargs) → plotly.graph_objects._figure.Figure

Update the properties of the figure’s layout with a dict and/or with keyword arguments.

This recursively updates the structure of the original layout with the values in the input dict / keyword arguments.

Parameters

• dict1 (dict) – Dictionary of properties to be updated

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• kwargs – Keyword/value pair of properties to be updated

Returns

The Figure object that the update_layout method was called on

Return type

BaseFigure

update_layout_images(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all images that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all images that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select images associated with the secondary y-axis of the subplot.

  • If False, only select images associated with the primary y-axis of the subplot.

  • If None (the default), do not filter images based on secondary y-axis.

  To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected image. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_legends(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all legend objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all legend objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• **kwargs – Additional property updates to apply to each selected legend object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_mapboxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all mapbox objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all mapbox objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• **kwargs – Additional property updates to apply to each selected mapbox object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_maps(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all map objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all map objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• **kwargs – Additional property updates to apply to each selected map object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_polars(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all polar objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all polar objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• **kwargs – Additional property updates to apply to each selected polar object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_scenes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all scene objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all scene objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• **kwargs – Additional property updates to apply to each selected scene object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_selections(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all selections that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all selections that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select selections associated with the secondary y-axis of the subplot.

  • If False, only select selections associated with the primary y-axis of the subplot.

  • If None (the default), do not filter selections based on secondary y-axis.

  To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected selection. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_shapes(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all shapes that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all shapes that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select shapes associated with the secondary y-axis of the subplot.

  • If False, only select shapes associated with the primary y-axis of the subplot.

  • If None (the default), do not filter shapes based on secondary y-axis.

  To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected shape. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_smiths(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all smith objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all smith objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• **kwargs – Additional property updates to apply to each selected smith object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_ternaries(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all ternary objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all ternary objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• **kwargs – Additional property updates to apply to each selected ternary object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_traces(patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all traces that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all traces that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all traces are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each trace and those for which the function returned True will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• col (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select traces associated with the secondary y-axis of the subplot.

  • If False, only select traces associated with the primary y-axis of the subplot.

  • If None (the default), do not filter traces based on secondary y-axis.

  To select traces by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• **kwargs – Additional property updates to apply to each selected trace. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_xaxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all xaxis objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all xaxis objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• **kwargs – Additional property updates to apply to each selected xaxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_yaxes(patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figure.Figure

Perform a property update operation on all yaxis objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all yaxis objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select yaxis objects associated with the secondary y-axis of the subplot.

  • If False, only select yaxis objects associated with the primary y-axis of the subplot.

  • If None (the default), do not filter yaxis objects based on a secondary y-axis condition.

  To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected yaxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

class plotly.graph_objects.FigureWidget(**kwargs: Any)

Bases: plotly.basewidget.BaseFigureWidget

add_annotation(arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

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 <br> HTML tags) or if an explicit width is set to override the text width.

• arrowcolor – Sets the color of the annotation arrow.

• arrowhead – Sets the end annotation arrow head style.

• arrowside – Sets the annotation arrow head position.

• arrowsize – Sets the size of the end annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line.

• arrowwidth – Sets the width (in px) of annotation arrow line.

• ax – Sets the x component of the arrow tail about the arrow head. If axref is pixel, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If axref is not pixel and is exactly the same as xref, this is an absolute value on that axis, like x, specified in the same coordinates as xref.

• axref – Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. In order for absolute positioning of the arrow to work, “axref” must be exactly the same as “xref”, otherwise “axref” will revert to “pixel” (explained next). For relative positioning, “axref” can be set to “pixel”, in which case the “ax” value is specified in pixels relative to “x”. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

• ay – Sets the y component of the arrow tail about the arrow head. If ayref is pixel, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If ayref is not pixel and is exactly the same as yref, this is an absolute value on that axis, like y, specified in the same coordinates as yref.

• ayref – Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. In order for absolute positioning of the arrow to work, “ayref” must be exactly the same as “yref”, otherwise “ayref” will revert to “pixel” (explained next). For relative positioning, “ayref” can be set to “pixel”, in which case the “ay” value is specified in pixels relative to “y”. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

• bgcolor – Sets the background color of the annotation.

• bordercolor – Sets the color of the border enclosing the annotation text.

• borderpad – Sets the padding (in px) between the text and the enclosing border.

• borderwidth – Sets the width (in px) of the border enclosing the annotation text.

• captureevents – Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default captureevents is False unless hovertext is provided. If you use the event plotly_clickannotation without hovertext you must explicitly enable captureevents.

• clicktoshow – Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the x and y values of this annotation, and it is hidden (visible: false), it will appear. In “onoff” mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In “onout” mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different x or y values, you can set xclick and/or yclick. This is useful for example to label the side of a bar. To label markers though, standoff is preferred over xclick and yclick.

• font – Sets the annotation text font.

• height – Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.

• hoverlabel – plotly.graph_objects.layout.annotation.Hoverlab el instance or dict with compatible properties

• hovertext – Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the annotation (text + arrow).

• showarrow – Determines whether or not the annotation is drawn with an arrow. If True, text is placed near the arrow’s tail. If False, text lines up with the x and y provided.

• standoff – Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount.

• startarrowhead – Sets the start annotation arrow head style.

• startarrowsize – Sets the size of the start annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line.

• startstandoff – Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• text – Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>, and <span> are also supported.

• textangle – Sets the angle at which the text is drawn with respect to the horizontal.

• valign – Sets the vertical alignment of the text within the box. Has an effect only if an explicit height is set to override the text height.

• visible – Determines whether or not this annotation is visible.

• width – Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.

• x – Sets the annotation’s x position. If the axis type is “log”, then you must take the log of your desired range. If the axis type is “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

• xanchor – Sets the text box’s horizontal position anchor This anchor binds the x position to the “left”, “center” or “right” of the annotation. For example, if x is set to 1, xref to “paper” and xanchor to “right” then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If “auto”, the anchor is equivalent to “center” for data- referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

• xclick – Toggle this annotation when clicking a data point whose x value is xclick rather than the annotation’s x value.

• xref – Sets the annotation’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• xshift – Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.

• y – Sets the annotation’s y position. If the axis type is “log”, then you must take the log of your desired range. If the axis type is “date”, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is “category”, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

• yanchor – Sets the text box’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the annotation. For example, if y is set to 1, yref to “paper” and yanchor to “top” then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If “auto”, the anchor is equivalent to “middle” for data-referenced annotations or if there is an arrow, whereas for paper- referenced with no arrow, the anchor picked corresponds to the closest side.

• yclick – Toggle this annotation when clicking a data point whose y value is yclick rather than the annotation’s y value.

• yref – Sets the annotation’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• yshift – Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.

• row – Subplot row for annotation. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for annotation. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add annotation to secondary y-axis

• exclude_empty_subplots – If True, annotation will not be added to subplots without traces.

Returns

Return type

FigureWidget

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Bar trace

The data visualized by the span of the bars is set in y if orientation is set to “v” (the default) and the labels are set in x. By setting orientation to “h”, the roles are interchanged.

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.bar.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.bar.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• offsetsrc – Sets the source reference on Chart Studio Cloud for offset.

• opacity – Sets the opacity of the trace.

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

• outsidetextfont – Sets the font used for text lying outside the bar.

• selected – plotly.graph_objects.bar.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.bar.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the font used for text.

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.bar.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the bar width (in position axis units).

• widthsrc – Sets the source reference on Chart Studio Cloud for width.

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_barpolar(base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.barpolar.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

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

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

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

• offsetsrc – Sets the source reference on Chart Studio Cloud for offset.

• opacity – Sets the opacity of the trace.

• r – Sets the radial coordinates

• r0 – Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

• rsrc – Sets the source reference on Chart Studio Cloud for r.

• selected – plotly.graph_objects.barpolar.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.barpolar.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a polar subplot. If “polar” (the default value), the data refer to layout.polar. If “polar2”, the data refer to layout.polar2, and so on.

• text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• theta – Sets the angular coordinates

• theta0 – Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

• thetasrc – Sets the source reference on Chart Studio Cloud for theta.

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

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.barpolar.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

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

• widthsrc – Sets the source reference on Chart Studio Cloud for width.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• jitter – Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es).

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.box.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.box.Line instance or dict with compatible properties

• lowerfence – Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If lowerfence is not provided but a sample (in y or x) is set, we compute the lower as the last sample point below 1.5 times the IQR.

• lowerfencesrc – Sets the source reference on Chart Studio Cloud for lowerfence.

• marker – plotly.graph_objects.box.Marker instance or dict with compatible properties

• mean – Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If mean is not provided but a sample (in y or x) is set, we compute the mean for each box using the sample values.

• meansrc – Sets the source reference on Chart Studio Cloud for mean.

• median – Sets the median values. There should be as many items as the number of boxes desired.

• mediansrc – Sets the source reference on Chart Studio Cloud for median.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical

• notched – Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes’ notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home /notched-box-plots for more info. Defaults to False unless notchwidth or notchspan is set.

• notchspan – Sets the notch span from the boxes’ median values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If notchspan is not provided but a sample (in y or x) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size.

• notchspansrc – Sets the source reference on Chart Studio Cloud for notchspan.

• notchwidth – Sets the width of the notches relative to the box width. For example, with 0, the notches are as wide as the box(es).

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

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

• pointpos – Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes

• q1 – Sets the Quartile 1 values. There should be as many items as the number of boxes desired.

• q1src – Sets the source reference on Chart Studio Cloud for q1.

• q3 – Sets the Quartile 3 values. There should be as many items as the number of boxes desired.

• q3src – Sets the source reference on Chart Studio Cloud for q3.

• quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

• sd – Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If sd is not provided but a sample (in y or x) is set, we compute the standard deviation for each box using the sample values.

• sdmultiple – Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev

• sdsrc – Sets the source reference on Chart Studio Cloud for sd.

• selected – plotly.graph_objects.box.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showwhiskers – Determines whether or not whiskers are visible. Defaults to true for sizemode “quartiles”, false for “sd”.

• sizemode – Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc

• stream – plotly.graph_objects.box.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.box.Unselected instance or dict with compatible properties

• upperfence – Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If upperfence is not provided but a sample (in y or x) is set, we compute the upper as the last sample point above 1.5 times the IQR.

• upperfencesrc – Sets the source reference on Chart Studio Cloud for upperfence.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• whiskerwidth – Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).

• width – Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot.

• x – Sets the x sample data or coordinates. See overview for more info.

• x0 – Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y sample data or coordinates. See overview for more info.

• y0 – Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_candlestick(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

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

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables open, high, low and close. 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• increasing – plotly.graph_objects.candlestick.Increasing instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.candlestick.Legendgrouptit le instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.candlestick.Line instance or dict with compatible properties

• low – Sets the low values.

• lowsrc – Sets the source reference on Chart Studio Cloud for low.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• open – Sets the open values.

• opensrc – Sets the source reference on Chart Studio Cloud for open.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.candlestick.Stream instance or dict with compatible properties

• text – Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• whiskerwidth – Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).

• x – Sets the x coordinates. If absent, linear coordinate will be generated.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_carpet(a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

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

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

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• da – Sets the a coordinate step. See a0 for more info.

• db – Sets the b coordinate step. See b0 for more info.

• font – The default font used for axis & tick labels on this carpet

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.carpet.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• stream – plotly.graph_objects.carpet.Stream instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – A two dimensional array of y coordinates at each carpet point.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

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, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

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: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example “properties.name”.

• geo – Sets a reference between this trace’s geospatial coordinates and a geographic map. If “geo” (the default value), the geospatial coordinates refer to layout.geo. If “geo2”, the geospatial coordinates refer to layout.geo2, and so on.

• geojson – Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.choropleth.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.choropleth.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locationmode – The library used by the country names locationmode option is changing in an upcoming version. Country names in existing plots may not work in the new version. Determines the set of locations used to match entries in locations to regions on the map. Values “ISO-3”, “USA-states”, country names correspond to features on the base map and value “geojson-id” corresponds to features from a custom GeoJSON linked to the geojson attribute.

• locations – Sets the coordinates via location IDs or names. See locationmode for more info.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• marker – plotly.graph_objects.choropleth.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• selected – plotly.graph_objects.choropleth.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.choropleth.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each location.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.choropleth.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the color values.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_choroplethmap(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Choroplethmap trace

GeoJSON features to be filled are set in geojson The data that describes the choropleth value-to-color mapping is set in locations and z.

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.

• below – Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.choroplethmap.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Support nested property, for example “properties.name”.

• geojson – Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.choroplethmap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.choroplethmap.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locations – Sets which features found in “geojson” to plot using their feature id field.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• marker – plotly.graph_objects.choroplethmap.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• selected – plotly.graph_objects.choroplethmap.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.choroplethmap.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

• text – Sets the text elements associated with each location.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.choroplethmap.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the color values.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_choroplethmapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Choroplethmapbox trace

“choroplethmapbox” trace is deprecated! Please consider switching to the “choroplethmap” trace type and map subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ GeoJSON features to be filled are set in geojson The data that describes the choropleth value-to-color mapping is set in locations and z.

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.

• below – Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.choroplethmapbox.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Support nested property, for example “properties.name”.

• geojson – Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.choroplethmapbox.Hoverlabe l instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.choroplethmapbox.Legendgro uptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locations – Sets which features found in “geojson” to plot using their feature id field.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• marker – plotly.graph_objects.choroplethmapbox.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• selected – plotly.graph_objects.choroplethmapbox.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.choroplethmapbox.Stream instance or dict with compatible properties

• subplot – mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre- migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

• text – Sets the text elements associated with each location.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.choroplethmapbox.Unselecte d instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the color values.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_cone(anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Cone trace

Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays x, y and z and 3 vector component arrays u, v, w. The cones are drawn exactly at the positions given by x, y and z.

Parameters

• anchor – Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.

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

• cauto – Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.cone.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.cone.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable norm Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.cone.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.cone.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.cone.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• sizemode – Determines whether sizeref is set as a “scaled” (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as “absolute” value (in the same units as the vector field). To display sizes in actual vector length use “raw”.

• sizeref – Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and sizeref. This factor (computed internally) corresponds to the minimum “time” to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With sizemode set to “raw”, its default value is 1. With sizemode set to “scaled”, sizeref is unitless, its default value is 0.5. With sizemode set to “absolute”, sizeref has the same units as the u/v/w vector field, its the default value is half the sample’s maximum vector norm.

• stream – plotly.graph_objects.cone.Stream instance or dict with compatible properties

• text – Sets the text elements associated with the cones. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• u – Sets the x components of the vector field.

• uhoverformat – Sets the hover text formatting rulefor u using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• usrc – Sets the source reference on Chart Studio Cloud for u.

• v – Sets the y components of the vector field.

• vhoverformat – Sets the hover text formatting rulefor v using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• vsrc – Sets the source reference on Chart Studio Cloud for v.

• w – Sets the z components of the vector field.

• whoverformat – Sets the hover text formatting rulefor w using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• wsrc – Sets the source reference on Chart Studio Cloud for w.

• x – Sets the x coordinates of the vector field and of the displayed cones.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates of the vector field and of the displayed cones.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates of the vector field and of the displayed cones.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_contour(autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Contour trace

The data from which contour lines are computed is set in z. Data in z must be a 2D list of numbers. Say that z has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in y or auto-generated) and the M columns correspond to M x coordinates (set in x or auto- generated). By setting transpose to True, the above behavior is flipped.

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.

• autocontour – Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in ncontours. If False, set the contour level attributes in contours.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.contour.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array otherwise it is defaulted to false.

• contours – plotly.graph_objects.contour.Contours instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• fillcolor – Sets the fill color if contours.type is “constraint”. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.contour.Hoverlabel instance or dict with compatible properties

• hoverongaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data have hover labels associated with them.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.contour.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.contour.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• ncontours – Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is True or if contours.size is missing.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.contour.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textfont – For this trace it only has an effect if coloring is set to “heatmap”. Sets the text font.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – For this trace it only has an effect if coloring is set to “heatmap”. Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• transpose – Transposes the z data.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• xtype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when x is provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior when x is not provided).

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• ytype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when y is provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior when y is not provided)

• z – Sets the z data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_contourcarpet(a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Contourcarpet trace

Plots contours on either the first carpet axis or the carpet axis with a matching carpet attribute. Data z is interpreted as matching that of the corresponding carpet axis.

Parameters

• a – Sets the x coordinates.

• a0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• asrc – Sets the source reference on Chart Studio Cloud for a.

• atype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when x is provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior when x is not provided).

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

• autocontour – Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in ncontours. If False, set the contour level attributes in contours.

• b – Sets the y coordinates.

• b0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• bsrc – Sets the source reference on Chart Studio Cloud for b.

• btype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when y is provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior when y is not provided)

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

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.contourcarpet.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contours – plotly.graph_objects.contourcarpet.Contours instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• da – Sets the x coordinate step. See x0 for more info.

• db – Sets the y coordinate step. See y0 for more info.

• fillcolor – Sets the fill color if contours.type is “constraint”. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.contourcarpet.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.contourcarpet.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• ncontours – Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is True or if contours.size is missing.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.contourcarpet.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• transpose – Transposes the z data.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• z – Sets the z data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_densitymap(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Densitymap trace

Draws a bivariate kernel density estimation with a Gaussian kernel from lon and lat coordinates and optional z values using a colorscale.

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.

• below – Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.densitymap.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.densitymap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.densitymap.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• radius – Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymap trace smoother, but less detailed.

• radiussrc – Sets the source reference on Chart Studio Cloud for radius.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.densitymap.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_densitymapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Densitymapbox trace

“densitymapbox” trace is deprecated! Please consider switching to the “densitymap” trace type and map subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Draws a bivariate kernel density estimation with a Gaussian kernel from lon and lat coordinates and optional z values using a colorscale.

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.

• below – Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to ‘’, the layer will be inserted above every existing layer.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.densitymapbox.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.densitymapbox.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.densitymapbox.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• radius – Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

• radiussrc – Sets the source reference on Chart Studio Cloud for radius.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.densitymapbox.Stream instance or dict with compatible properties

• subplot – mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre- migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• z – Sets the points’ weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_funnel(alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Funnel trace

Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a “drop-off” representation wherein each item appears in each stage it traversed. See also the “funnelarea” trace type for a different approach to visualizing funnel data.

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.

• cliponaxis – Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connector – plotly.graph_objects.funnel.Connector instance or dict with compatible properties

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

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.funnel.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious and percentTotal. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.funnel.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.funnel.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

• orientation – Sets the orientation of the funnels. With “v” (“h”), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only “y” array is presented or orientation is set to “v”. Also regarding graphs including only ‘horizontal’ funnels, “autorange” on the “y-axis” are set to “reversed”.

• outsidetextfont – Sets the font used for text lying outside the bar.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.funnel.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the font used for text.

• textinfo – Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious, percentTotal, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the bar width (in position axis units).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_funnelarea(aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Funnelarea trace

Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a “pie” trace, wherein each item appears in a single stage. See also the “funnel” trace type for a different approach to visualizing funnel data.

Parameters

• aspectratio – Sets the ratio between height and width

• baseratio – Sets the ratio between bottom length and maximum top length.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dlabel – Sets the label step. See label0 for more info.

• domain – plotly.graph_objects.funnelarea.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.funnelarea.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• label0 – Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

• labels – Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.funnelarea.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.funnelarea.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• scalegroup – If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.funnelarea.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Specifies the location of the textinfo.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• title – plotly.graph_objects.funnelarea.Title instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values of the sectors. If omitted, we count occurrences of each label.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_heatmap(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Heatmap trace

The data that describes the heatmap value-to-color mapping is set in z. Data in z can either be a 2D list of values (ragged or not) or a 1D array of values. In the case where z is a 2D list, say that z has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in z is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using transpose. Moreover, x (y) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where z is a 1D list, the x and y coordinates must be provided in x and y respectively to form data triplets.

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.heatmap.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array and zsmooth is not false; otherwise it is defaulted to false.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.heatmap.Hoverlabel instance or dict with compatible properties

• hoverongaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data have hover labels associated with them.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.heatmap.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.heatmap.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textfont – Sets the text font.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• transpose – Transposes the z data.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xgap – Sets the horizontal gap (in pixels) between bricks.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• xtype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when x is provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior when x is not provided).

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• ygap – Sets the vertical gap (in pixels) between bricks.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• ytype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when y is provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior when y is not provided)

• z – Sets the z data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsmooth – Picks a smoothing algorithm use to smooth z data.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_histogram(alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Histogram trace

The sample data from which statistics are computed is set in x for vertically spanning histograms and in y for horizontally spanning histograms. Binning options are set xbins and ybins respectively if no aggregation data is provided.

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.

• autobinx – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

• autobiny – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

• bingroup – Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same “orientation” under barmode “stack”, “relative” and “group” are forced into the same bingroup, Using bingroup, traces under barmode “overlay” and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same bingroup

• cliponaxis – Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

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

• cumulative – plotly.graph_objects.histogram.Cumulative instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• error_x – plotly.graph_objects.histogram.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.histogram.ErrorY instance or dict with compatible properties

• histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

• histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.histogram.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable binNumber Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.histogram.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.histogram.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• nbinsx – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

• nbinsy – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

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

• outsidetextfont – Sets the font used for text lying outside the bar.

• selected – plotly.graph_objects.histogram.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.histogram.Stream instance or dict with compatible properties

• text – Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the text font.

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.histogram.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the sample data to be binned on the x axis.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xbins – plotly.graph_objects.histogram.XBins instance or dict with compatible properties

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the sample data to be binned on the y axis.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ybins – plotly.graph_objects.histogram.YBins instance or dict with compatible properties

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_histogram2d(autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Histogram2d trace

The sample data from which statistics are computed is set in x and y (where x and y represent marginal distributions, binning is set in xbins and ybins in this case) or z (where z represent the 2D distribution and binning set, binning is set by x and y in this case). The resulting distribution is visualized as a heatmap.

Parameters

• autobinx – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

• autobiny – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

• bingroup – Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.histogram2d.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

• histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.histogram2d.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.histogram2d.Legendgrouptit le instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.histogram2d.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• nbinsx – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

• nbinsy – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.histogram2d.Stream instance or dict with compatible properties

• textfont – Sets the text font.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the sample data to be binned on the x axis.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xbingroup – Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

• xbins – plotly.graph_objects.histogram2d.XBins instance or dict with compatible properties

• xcalendar – Sets the calendar system to use with x date data.

• xgap – Sets the horizontal gap (in pixels) between bricks.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the sample data to be binned on the y axis.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ybingroup – Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

• ybins – plotly.graph_objects.histogram2d.YBins instance or dict with compatible properties

• ycalendar – Sets the calendar system to use with y date data.

• ygap – Sets the vertical gap (in pixels) between bricks.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the aggregation data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsmooth – Picks a smoothing algorithm use to smooth z data.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_histogram2dcontour(autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Histogram2dContour trace

The sample data from which statistics are computed is set in x and y (where x and y represent marginal distributions, binning is set in xbins and ybins in this case) or z (where z represent the 2D distribution and binning set, binning is set by x and y in this case). The resulting distribution is visualized as a contour plot.

Parameters

• autobinx – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

• autobiny – Obsolete: since v1.42 each bin attribute is auto- determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

• autocontour – Determines whether or not the contour level attributes are picked by an algorithm. If True, the number of contour levels can be set in ncontours. If False, set the contour level attributes in contours.

• bingroup – Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.histogram2dcontour.ColorBa r instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contours – plotly.graph_objects.histogram2dcontour.Contour s instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• histfunc – Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

• histnorm – Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.histogram2dcontour.Hoverla bel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.histogram2dcontour.Legendg rouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.histogram2dcontour.Line instance or dict with compatible properties

• marker – plotly.graph_objects.histogram2dcontour.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• nbinsx – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

• nbinsy – Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

• ncontours – Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is True or if contours.size is missing.

• opacity – Sets the opacity of the trace.

• reversescale – Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.histogram2dcontour.Stream instance or dict with compatible properties

• textfont – For this trace it only has an effect if coloring is set to “heatmap”. Sets the text font.

• texttemplate – For this trace it only has an effect if coloring is set to “heatmap”. Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the sample data to be binned on the x axis.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xbingroup – Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

• xbins – plotly.graph_objects.histogram2dcontour.XBins instance or dict with compatible properties

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the sample data to be binned on the y axis.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ybingroup – Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

• ybins – plotly.graph_objects.histogram2dcontour.YBins instance or dict with compatible properties

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the aggregation data.

• zauto – Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• zmax – Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

• zmid – Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

• zmin – Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_hline(y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a horizontal line to a plot or subplot that extends infinitely in the x-dimension.

Parameters

• y (float or int) – A number representing the y coordinate of the horizontal line.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the line. Example positions are “bottom left”, “right top”, “right”, “bottom”. If an annotation is added but annotation_position is not specified, this defaults to “top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_hrect(y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a rectangle to a plot or subplot that extends infinitely in the x-dimension.

Parameters

• y0 (float or int) – A number representing the y coordinate of one side of the rectangle.

• y1 (float or int) – A number representing the y coordinate of the other side of the rectangle.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["inside", "outside"], ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the rectangle. Example positions are “outside top left”, “inside bottom”, “right”, “inside left”, “inside” (“outside” is not supported). If an annotation is added but annotation_position is not specified this defaults to “inside top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_icicle(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Icicle trace

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The icicle sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

• branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

• count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.icicle.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.icicle.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• labels – Sets the labels of each of the sectors.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• leaf – plotly.graph_objects.icicle.Leaf instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.icicle.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

• marker – plotly.graph_objects.icicle.Marker instance or dict with compatible properties

• maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

• parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

• parentssrc – Sets the source reference on Chart Studio Cloud for parents.

• pathbar – plotly.graph_objects.icicle.Pathbar instance or dict with compatible properties

• root – plotly.graph_objects.icicle.Root instance or dict with compatible properties

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.icicle.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Sets the positions of the text elements.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• tiling – plotly.graph_objects.icicle.Tiling instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_image(colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Image trace

Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. autorange: 'reversed'), constrained to the domain (ie. constrain: 'domain') and it will have the same scale as its x axis (ie. scaleanchor: 'x,) in order for pixels to be rendered as squares.

Parameters

• colormodel – Color model used to map the numerical color components described in z into colors. If source is specified, this attribute will be set to rgba256 otherwise it defaults to rgb.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Set the pixel’s horizontal size.

• dy – Set the pixel’s vertical size

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.image.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables z, color and colormodel. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.image.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• source – Specifies the data URI of the image to be visualized. The URI consists of “data:image/[<media subtype>][;base64],<data>”

• stream – plotly.graph_objects.image.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each z value.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x0 – Set the image’s x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• y0 – Set the image’s y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• z – A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

• zmax – Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the rgb colormodel, it is [255, 255, 255]. For the rgba colormodel, it is [255, 255, 255, 1]. For the rgba256 colormodel, it is [255, 255, 255, 255]. For the hsl colormodel, it is [360, 100, 100]. For the hsla colormodel, it is [360, 100, 100, 1].

• zmin – Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the rgb colormodel, it is [0, 0, 0]. For the rgba colormodel, it is [0, 0, 0, 0]. For the rgba256 colormodel, it is [0, 0, 0, 0]. For the hsl colormodel, it is [0, 0, 0]. For the hsla colormodel, it is [0, 0, 0, 0].

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• zsmooth – Picks a smoothing algorithm used to smooth z data. This only applies for image traces that use the source attribute.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_indicator(align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Indicator trace

An indicator is used to visualize a single value along with some contextual information such as steps or a threshold, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a reference. Gauges can be either angular or bullet (aka linear) gauges.

Parameters

• align – Sets the horizontal alignment of the text within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• delta – plotly.graph_objects.indicator.Delta instance or dict with compatible properties

• domain – plotly.graph_objects.indicator.Domain instance or dict with compatible properties

• gauge – The gauge of the Indicator plot.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – :class:`plotly.graph_objects.indicator.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines how the value is displayed on the graph. number displays the value numerically in text. delta displays the difference to a reference value in text. Finally, gauge displays the value graphically on an axis.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• number – plotly.graph_objects.indicator.Number instance or dict with compatible properties

• stream – plotly.graph_objects.indicator.Stream instance or dict with compatible properties

• title – plotly.graph_objects.indicator.Title instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• value – Sets the number to be displayed.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_isosurface(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Isosurface trace

Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the value, x, y and z of every vertex of a uniform or non- uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace.

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.

• caps – plotly.graph_objects.isosurface.Caps instance or dict with compatible properties

• cauto – Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as value and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.isosurface.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contour – plotly.graph_objects.isosurface.Contour instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.isosurface.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• isomax – Sets the maximum boundary for iso-surface plot.

• isomin – Sets the minimum boundary for iso-surface plot.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.isosurface.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.isosurface.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.isosurface.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• slices – plotly.graph_objects.isosurface.Slices instance or dict with compatible properties

• spaceframe – plotly.graph_objects.isosurface.Spaceframe instance or dict with compatible properties

• stream – plotly.graph_objects.isosurface.Stream instance or dict with compatible properties

• surface – plotly.graph_objects.isosurface.Surface instance or dict with compatible properties

• text – Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• value – Sets the 4th dimension (value) of the vertices.

• valuehoverformat – Sets the hover text formatting rulefor value using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• valuesrc – Sets the source reference on Chart Studio Cloud for value.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the X coordinates of the vertices on X axis.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the Y coordinates of the vertices on Y axis.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the Z coordinates of the vertices on Z axis.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_layout_image(arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Create and add a new image to the figure’s layout

Parameters

• arg – instance of Image or dict with compatible properties

• layer – Specifies whether images are drawn below or above traces. When xref and yref are both set to paper, image is drawn below the entire plot area.

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the image.

• sizex – Sets the image container size horizontally. The image will be sized based on the position value. When xref is set to paper, units are sized relative to the plot width. When xref ends with ` domain`, units are sized relative to the axis width.

• sizey – Sets the image container size vertically. The image will be sized based on the position value. When yref is set to paper, units are sized relative to the plot height. When yref ends with ` domain`, units are sized relative to the axis height.

• sizing – Specifies which dimension of the image to constrain.

• source – Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• visible – Determines whether or not this image is visible.

• x – Sets the image’s x position. When xref is set to paper, units are sized relative to the plot height. See xref for more info

• xanchor – Sets the anchor for the x position

• xref – Sets the images’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• y – Sets the image’s y position. When yref is set to paper, units are sized relative to the plot height. See yref for more info

• yanchor – Sets the anchor for the y position.

• yref – Sets the images’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• row – Subplot row for image. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for image. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add image to secondary y-axis

• exclude_empty_subplots – If True, image will not be added to subplots without traces.

Returns

Return type

FigureWidget

add_mesh3d(alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Mesh3d trace

Draws sets of triangles with coordinates given by three 1-dimensional arrays in x, y, z and (1) a sets of i, j, k indices (2) Delaunay triangulation or (3) the Alpha- shape algorithm or (4) the Convex-hull algorithm

Parameters

• alphahull – Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the x, y and z arrays, if the i, j, k arrays are not supplied. For general use of mesh3d it is preferred that i, j, k are supplied. If “-1”, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to delaunayaxis. In case the delaunayaxis intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of delaunayaxis. If “>0”, the alpha-shape algorithm is used. In this case, the positive alphahull value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the x, y and z point set into a convex hull.

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

• cauto – Determines whether or not the color domain is computed with respect to the input data (here intensity) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as intensity and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as intensity and if set, cmax must be set as well.

• color – Sets the color of the whole mesh

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.mesh3d.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contour – plotly.graph_objects.mesh3d.Contour instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• delaunayaxis – Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if i, j, k are not provided and alphahull is set to indicate Delaunay triangulation.

• facecolor – Sets the color of each face Overrides “color” and “vertexcolor”.

• facecolorsrc – Sets the source reference on Chart Studio Cloud for facecolor.

• flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.mesh3d.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• i – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “first” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where i[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in i represents a point in space, which is the first vertex of a triangle.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• intensity – Sets the intensity values for vertices or cells as defined by intensitymode. It can be used for plotting fields on meshes.

• intensitymode – Determines the source of intensity values.

• intensitysrc – Sets the source reference on Chart Studio Cloud for intensity.

• isrc – Sets the source reference on Chart Studio Cloud for i.

• j – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “second” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where j[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in j represents a point in space, which is the second vertex of a triangle.

• jsrc – Sets the source reference on Chart Studio Cloud for j.

• k – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “third” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where k[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in k represents a point in space, which is the third vertex of a triangle.

• ksrc – Sets the source reference on Chart Studio Cloud for k.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.mesh3d.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.mesh3d.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.mesh3d.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.mesh3d.Stream instance or dict with compatible properties

• text – Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• vertexcolor – Sets the color of each vertex Overrides “color”. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.

• vertexcolorsrc – Sets the source reference on Chart Studio Cloud for vertexcolor.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the X coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the Y coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the Z coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

• zcalendar – Sets the calendar system to use with z date data.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_ohlc(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Ohlc trace

The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given x coordinate (most likely time). The tip of the lines represent the low and high values and the horizontal segments represent the open and close values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red.

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.ohlc.Decreasing instance or dict with compatible properties

• high – Sets the high values.

• highsrc – Sets the source reference on Chart Studio Cloud for high.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.ohlc.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables open, high, low and close. 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

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

• increasing – plotly.graph_objects.ohlc.Increasing instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.ohlc.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.ohlc.Line instance or dict with compatible properties

• low – Sets the low values.

• lowsrc – Sets the source reference on Chart Studio Cloud for low.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• open – Sets the open values.

• opensrc – Sets the source reference on Chart Studio Cloud for open.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.ohlc.Stream instance or dict with compatible properties

• text – Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace’s sample points.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• tickwidth – Sets the width of the open/close tick marks relative to the “x” minimal interval.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates. If absent, linear coordinate will be generated.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_parcats(arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Parcats trace

Parallel categories diagram for multidimensional categorical data.

Parameters

• arrangement – Sets the drag interaction mode for categories and dimensions. If perpendicular, the categories can only move along a line perpendicular to the paths. If freeform, the categories can freely move on the plane. If fixed, the categories and dimensions are stationary.

• bundlecolors – Sort paths so that like colors are bundled together within each category.

• counts – The number of observations represented by each state. Defaults to 1 so that each state represents one observation

• countssrc – Sets the source reference on Chart Studio Cloud for counts.

• dimensions – The dimensions (variables) of the parallel categories diagram.

• dimensiondefaults – When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions

• domain – plotly.graph_objects.parcats.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoveron – Sets the hover interaction mode for the parcats diagram. If category, hover interaction take place per category. If color, hover interactions take place per color per category. If dimension, hover interactions take place across all categories per dimension.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables count, probability, category, categorycount, colorcount and bandcolorcount. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• labelfont – Sets the font for the dimension labels.

• legendgrouptitle – plotly.graph_objects.parcats.Legendgrouptitle instance or dict with compatible properties

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.parcats.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• sortpaths – Sets the path sorting algorithm. If forward, sort paths based on dimension categories from left to right. If backward, sort paths based on dimensions categories from right to left.

• stream – plotly.graph_objects.parcats.Stream instance or dict with compatible properties

• tickfont – Sets the font for the category labels.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_parcoords(customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Parcoords trace

Parallel coordinates for multidimensional exploratory data analysis. The samples are specified in dimensions. The colors are set in line.color.

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.

• dimensions – The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.

• dimensiondefaults – When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions

• domain – plotly.graph_objects.parcoords.Domain instance or dict with compatible properties

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• labelangle – Sets the angle of the labels with respect to the horizontal. For example, a tickangle of -90 draws the labels vertically. Tilted labels with “labelangle” may be positioned better inside margins when labelposition is set to “bottom”.

• labelfont – Sets the font for the dimension labels.

• labelside – Specifies the location of the label. “top” positions labels above, next to the title “bottom” positions labels below the graph Tilted labels with “labelangle” may be positioned better inside margins when labelposition is set to “bottom”.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – :class:`plotly.graph_objects.parcoords.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.parcoords.Line instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• rangefont – Sets the font for the dimension range values.

• stream – plotly.graph_objects.parcoords.Stream instance or dict with compatible properties

• tickfont – Sets the font for the dimension tick values.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.parcoords.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_pie(automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Pie trace

A data visualized by the sectors of the pie is set in values. The sector labels are set in labels. The sector colors are set in marker.colors

Parameters

• automargin – Determines whether outside text labels can push the margins.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• direction – Specifies the direction at which succeeding sectors follow one another.

• dlabel – Sets the label step. See label0 for more info.

• domain – plotly.graph_objects.pie.Domain instance or dict with compatible properties

• hole – Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.pie.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• insidetextorientation – Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.

• label0 – Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

• labels – Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.pie.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.pie.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector.

• pull – Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

• pullsrc – Sets the source reference on Chart Studio Cloud for pull.

• rotation – Instead of the first slice starting at 12 o’clock, rotate to some other angle.

• scalegroup – If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.pie.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Specifies the location of the textinfo.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• title – plotly.graph_objects.pie.Title instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values of the sectors. If omitted, we count occurrences of each label.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_sankey(arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Sankey trace

Sankey plots for network flow data analysis. The nodes are specified in nodes and the links between sources and targets in links. The colors are set in nodes[i].color and links[i].color, otherwise defaults are used.

Parameters

• arrangement – If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad. If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.sankey.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

• hoverlabel – plotly.graph_objects.sankey.Hoverlabel instance or dict with compatible properties

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.sankey.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• link – The links of the Sankey plot.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• node – The nodes of the Sankey plot.

• orientation – Sets the orientation of the Sankey diagram.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• stream – plotly.graph_objects.sankey.Stream instance or dict with compatible properties

• textfont – Sets the font for node labels

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• valueformat – Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.

• valuesuffix – Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scatter(alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scatter trace

The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in x and y. Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

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.

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• error_x – plotly.graph_objects.scatter.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.scatter.ErrorY instance or dict with compatible properties

• fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

• fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.

• fillgradient – Sets a fill gradient. If not specified, the fillcolor is used instead.

• fillpattern – Sets the pattern within the marker.

• groupnorm – Only relevant when stackgroup is used, and only the first groupnorm found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the normalization for the sum of this stackgroup. With “fraction”, the value of each trace at each location is divided by the sum of all trace values at that location. “percent” is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatter.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatter.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatter.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatter.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

• orientation – Only relevant in the following cases: 1. when scattermode is set to “group”. 2. when stackgroup is used, and only the first orientation found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the stacking direction. With “v” (“h”), the y (x) values of subsequent traces are added. Also affects the default value of fill.

• selected – plotly.graph_objects.scatter.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stackgaps – Only relevant when stackgroup is used, and only the first stackgaps found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Determines how we handle locations at which other traces in this group have data but this one does not. With infer zero we insert a zero at these locations. With “interpolate” we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

• stackgroup – Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if orientation is “h”). If blank or omitted this trace will not be stacked. Stacking also turns fill on by default, using “tonexty” (“tonextx”) if orientation is “h” (“v”) and sets the default mode to “lines” irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

• stream – plotly.graph_objects.scatter.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatter.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_scatter3d(connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scatter3d trace

The data visualized as scatter point or lines in 3D dimension is set in x, y, z. Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color Projections are achieved via projection. Surface fills are achieved via surfaceaxis.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• error_x – plotly.graph_objects.scatter3d.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.scatter3d.ErrorY instance or dict with compatible properties

• error_z – plotly.graph_objects.scatter3d.ErrorZ instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatter3d.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y,z) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.scatter3d.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatter3d.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatter3d.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• projection – plotly.graph_objects.scatter3d.Projection instance or dict with compatible properties

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatter3d.Stream instance or dict with compatible properties

• surfaceaxis – If “-1”, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

• surfacecolor – Sets the surface fill color.

• text – Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y,z) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates.

• zcalendar – Sets the calendar system to use with z date data.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scattercarpet(a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scattercarpet trace

Plots a scatter trace on either the first carpet axis or the carpet axis with a matching carpet attribute.

Parameters

• a – Sets the a-axis coordinates.

• asrc – Sets the source reference on Chart Studio Cloud for a.

• b – Sets the b-axis coordinates.

• bsrc – Sets the source reference on Chart Studio Cloud for b.

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

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattercarpet.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattercarpet.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattercarpet.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scattercarpet.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattercarpet.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattercarpet.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattercarpet.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_scattergeo(connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scattergeo trace

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in lon and lat respectively or by geographic location IDs or names in locations.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example “properties.name”.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

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

• geo – Sets a reference between this trace’s geospatial coordinates and a geographic map. If “geo” (the default value), the geospatial coordinates refer to layout.geo. If “geo2”, the geospatial coordinates refer to layout.geo2, and so on.

• geojson – Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when locations is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattergeo.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattergeo.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattergeo.Line instance or dict with compatible properties

• locationmode – The library used by the country names locationmode option is changing in an upcoming version. Country names in existing plots may not work in the new version. Determines the set of locations used to match entries in locations to regions on the map. Values “ISO-3”, “USA-states”, country names correspond to features on the base map and value “geojson-id” corresponds to features from a custom GeoJSON linked to the geojson attribute.

• locations – Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See locationmode for more info.

• locationssrc – Sets the source reference on Chart Studio Cloud for locations.

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• marker – plotly.graph_objects.scattergeo.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattergeo.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattergeo.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon, location and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattergeo.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scattergl(connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scattergl trace

The data visualized as scatter point or lines is set in x and y using the WebGL plotting engine. Bubble charts are achieved by setting marker.size and/or marker.color to a numerical arrays.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• error_x – plotly.graph_objects.scattergl.ErrorX instance or dict with compatible properties

• error_y – plotly.graph_objects.scattergl.ErrorY instance or dict with compatible properties

• fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattergl.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.scattergl.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattergl.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scattergl.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattergl.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattergl.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattergl.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_scattermap(below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scattermap trace

The data visualized as scatter point, lines or marker symbols on a MapLibre GL geographic map is provided by longitude/latitude pairs in lon and lat.

Parameters

• below – Determines if this scattermap trace’s layers are to be inserted before the layer with the specified ID. By default, scattermap layers are inserted above all the base layers. To place the scattermap layers above every other layer, set below to “’’”.

• cluster – plotly.graph_objects.scattermap.Cluster instance or dict with compatible properties

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattermap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattermap.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattermap.Line instance or dict with compatible properties

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• marker – plotly.graph_objects.scattermap.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattermap.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattermap.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the icon text font (color=map.layer.paint.text- color, size=map.layer.layout.text-size). Has an effect only when type is set to “symbol”.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattermap.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scattermapbox(below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scattermapbox trace

“scattermapbox” trace is deprecated! Please consider switching to the “scattermap” trace type and map subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ The data visualized as scatter point, lines or marker symbols on a Mapbox GL geographic map is provided by longitude/latitude pairs in lon and lat.

Parameters

• below – Determines if this scattermapbox trace’s layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set below to “’’”.

• cluster – plotly.graph_objects.scattermapbox.Cluster instance or dict with compatible properties

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattermapbox.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• lat – Sets the latitude coordinates (in degrees North).

• latsrc – Sets the source reference on Chart Studio Cloud for lat.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattermapbox.Legendgroupt itle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattermapbox.Line instance or dict with compatible properties

• lon – Sets the longitude coordinates (in degrees East).

• lonsrc – Sets the source reference on Chart Studio Cloud for lon.

• marker – plotly.graph_objects.scattermapbox.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scattermapbox.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattermapbox.Stream instance or dict with compatible properties

• subplot – mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre- migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

• text – Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the icon text font (color=mapbox.layer.paint.text- color, size=mapbox.layer.layout.text-size). Has an effect only when type is set to “symbol”.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattermapbox.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scatterpolar(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scatterpolar trace

The scatterpolar trace type encompasses line charts, scatter charts, text charts, and bubble charts in polar coordinates. The data visualized as scatter point or lines is set in r (radial) and theta (angular) coordinates Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dr – Sets the r coordinate step.

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

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterpolar has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatterpolar.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatterpolar.Legendgroupti tle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatterpolar.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatterpolar.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• r – Sets the radial coordinates

• r0 – Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

• rsrc – Sets the source reference on Chart Studio Cloud for r.

• selected – plotly.graph_objects.scatterpolar.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatterpolar.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a polar subplot. If “polar” (the default value), the data refer to layout.polar. If “polar2”, the data refer to layout.polar2, and so on.

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• theta – Sets the angular coordinates

• theta0 – Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

• thetasrc – Sets the source reference on Chart Studio Cloud for theta.

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

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatterpolar.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scatterpolargl(connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scatterpolargl trace

The scatterpolargl trace type encompasses line charts, scatter charts, and bubble charts in polar coordinates using the WebGL plotting engine. The data visualized as scatter point or lines is set in r (radial) and theta (angular) coordinates Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• dr – Sets the r coordinate step.

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

• fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatterpolargl.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatterpolargl.Legendgroup title instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatterpolargl.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatterpolargl.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• r – Sets the radial coordinates

• r0 – Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

• rsrc – Sets the source reference on Chart Studio Cloud for r.

• selected – plotly.graph_objects.scatterpolargl.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatterpolargl.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a polar subplot. If “polar” (the default value), the data refer to layout.polar. If “polar2”, the data refer to layout.polar2, and so on.

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• theta – Sets the angular coordinates

• theta0 – Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

• thetasrc – Sets the source reference on Chart Studio Cloud for theta.

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

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatterpolargl.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scattersmith(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scattersmith trace

The scattersmith trace type encompasses line charts, scatter charts, text charts, and bubble charts in smith coordinates. The data visualized as scatter point or lines is set in real and imag (imaginary) coordinates Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scattersmith has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scattersmith.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• imag – Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

• imagsrc – Sets the source reference on Chart Studio Cloud for imag.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scattersmith.Legendgroupti tle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scattersmith.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scattersmith.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• real – Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

• realsrc – Sets the source reference on Chart Studio Cloud for real.

• selected – plotly.graph_objects.scattersmith.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scattersmith.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a smith subplot. If “smith” (the default value), the data refer to layout.smith. If “smith2”, the data refer to layout.smith2, and so on.

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables real, imag and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scattersmith.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_scatterternary(a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Scatterternary trace

Provides similar functionality to the “scatter” type but on a ternary phase diagram. The data is provided by at least two arrays out of a, b, c triplets.

Parameters

• a – Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

• asrc – Sets the source reference on Chart Studio Cloud for a.

• b – Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

• bsrc – Sets the source reference on Chart Studio Cloud for b.

• c – Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

• cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• csrc – Sets the source reference on Chart Studio Cloud for c.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• fill – Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.scatterternary.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.scatterternary.Legendgroup title instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.scatterternary.Line instance or dict with compatible properties

• marker – plotly.graph_objects.scatterternary.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.scatterternary.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.scatterternary.Stream instance or dict with compatible properties

• subplot – Sets a reference between this trace’s data coordinates and a ternary subplot. If “ternary” (the default value), the data refer to layout.ternary. If “ternary2”, the data refer to layout.ternary2, and so on.

• sum – The number each triplet should sum to, if only two of a, b, and c are provided. This overrides ternary<i>.sum to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sum

• text – Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the text font.

• textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b, c and text.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.scatterternary.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_selection(arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Create and add a new selection to the figure’s layout

Parameters

• arg – instance of Selection or dict with compatible properties

• line – plotly.graph_objects.layout.selection.Line instance or dict with compatible properties

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the selection.

• path – For type “path” - a valid SVG path similar to shapes.path in data coordinates. Allowed segments are: M, L and Z.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• type – Specifies the selection type to be drawn. If “rect”, a rectangle is drawn linking (x0,`y0`), (x1,`y0`), (x1,`y1`) and (x0,`y1`). If “path”, draw a custom SVG path using path.

• x0 – Sets the selection’s starting x position.

• x1 – Sets the selection’s end x position.

• xref – Sets the selection’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• y0 – Sets the selection’s starting y position.

• y1 – Sets the selection’s end y position.

• yref – Sets the selection’s x coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• row – Subplot row for selection. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for selection. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add selection to secondary y-axis

• exclude_empty_subplots – If True, selection will not be added to subplots without traces.

Returns

Return type

FigureWidget

add_shape(arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Create and add a new shape to the figure’s layout

Parameters

• arg – instance of Shape or dict with compatible properties

• editable – Determines whether the shape could be activated for edit or not. Has no effect when the older editable shapes mode is enabled via config.editable or config.edits.shapePosition.

• fillcolor – Sets the color filling the shape’s interior. Only applies to closed shapes.

• fillrule – Determines which regions of complex paths constitute the interior. For more info please visit https://developer.mozilla.org/en- US/docs/Web/SVG/Attribute/fill-rule

• label – plotly.graph_objects.layout.shape.Label instance or dict with compatible properties

• layer – Specifies whether shapes are drawn below gridlines (“below”), between gridlines and traces (“between”) or above traces (“above”).

• legend – Sets the reference to a legend to show this shape in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgroup – Sets the legend group for this shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

• legendgrouptitle – plotly.graph_objects.layout.shape.Legendgroupti tle instance or dict with compatible properties

• legendrank – Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this shape.

• line – plotly.graph_objects.layout.shape.Line instance or dict with compatible properties

• name – When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

• opacity – Sets the opacity of the shape.

• path – For type “path” - a valid SVG path with the pixel values replaced by data values in xsizemode/ysizemode being “scaled” and taken unmodified as pixels relative to xanchor and yanchor in case of “pixel” size mode. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained “polybezier” commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can’t use either to separate date from time parts. Therefore we’ll use underscore for this purpose: 2015-02-21_13:45:56.789

• showlegend – Determines whether or not this shape is shown in the legend.

• templateitemname – Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

• type – Specifies the shape type to be drawn. If “line”, a line is drawn from (x0,`y0`) to (x1,`y1`) with respect to the axes’ sizing mode. If “circle”, a circle is drawn from ((x0`+`x1)/2, (y0`+`y1)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes’ sizing mode. If “rect”, a rectangle is drawn linking (x0,`y0`), (x1,`y0`), (x1,`y1`), (x0,`y1`), (x0,`y0`) with respect to the axes’ sizing mode. If “path”, draw a custom SVG path using path. with respect to the axes’ sizing mode.

• visible – Determines whether or not this shape is visible. If “legendonly”, the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x0 – Sets the shape’s starting x position. See type and xsizemode for more info.

• x0shift – Shifts x0 away from the center of the category when xref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• x1 – Sets the shape’s end x position. See type and xsizemode for more info.

• x1shift – Shifts x1 away from the center of the category when xref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• xanchor – Only relevant in conjunction with xsizemode set to “pixel”. Specifies the anchor point on the x axis to which x0, x1 and x coordinates within path are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when xsizemode not set to “pixel”.

• xref – Sets the shape’s x coordinate axis. If set to a x axis id (e.g. “x” or “x2”), the x position refers to a x coordinate. If set to “paper”, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

• xsizemode – Sets the shapes’s sizing mode along the x axis. If set to “scaled”, x0, x1 and x coordinates within path refer to data values on the x axis or a fraction of the plot area’s width (xref set to “paper”). If set to “pixel”, xanchor specifies the x position in terms of data or plot fraction but x0, x1 and x coordinates within path are pixels relative to xanchor. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.

• y0 – Sets the shape’s starting y position. See type and ysizemode for more info.

• y0shift – Shifts y0 away from the center of the category when yref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• y1 – Sets the shape’s end y position. See type and ysizemode for more info.

• y1shift – Shifts y1 away from the center of the category when yref is a “category” or “multicategory” axis. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.

• yanchor – Only relevant in conjunction with ysizemode set to “pixel”. Specifies the anchor point on the y axis to which y0, y1 and y coordinates within path are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when ysizemode not set to “pixel”.

• yref – Sets the shape’s y coordinate axis. If set to a y axis id (e.g. “y” or “y2”), the y position refers to a y coordinate. If set to “paper”, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by “domain” (separated by a space), the position behaves like for “paper”, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

• ysizemode – Sets the shapes’s sizing mode along the y axis. If set to “scaled”, y0, y1 and y coordinates within path refer to data values on the y axis or a fraction of the plot area’s height (yref set to “paper”). If set to “pixel”, yanchor specifies the y position in terms of data or plot fraction but y0, y1 and y coordinates within path are pixels relative to yanchor. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.

• row – Subplot row for shape. If ‘all’, addresses all rows in the specified column(s).

• col – Subplot column for shape. If ‘all’, addresses all columns in the specified row(s).

• secondary_y – Whether to add shape to secondary y-axis

• exclude_empty_subplots – If True, shape will not be added to subplots without traces.

Returns

Return type

FigureWidget

add_splom(customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Splom trace

Splom traces generate scatter plot matrix visualizations. Each splom dimensions items correspond to a generated axis. Values for each of those dimensions are set in dimensions[i].values. Splom traces support all scattergl marker style attributes. Specify layout.grid attributes and/or layout x-axis and y-axis attributes for more control over the axis positioning and style.

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.

• diagonal – plotly.graph_objects.splom.Diagonal instance or dict with compatible properties

• dimensions – A tuple of plotly.graph_objects.splom.Dimension instances or dicts with compatible properties

• dimensiondefaults – When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.splom.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.splom.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• marker – plotly.graph_objects.splom.Marker instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• selected – plotly.graph_objects.splom.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showlowerhalf – Determines whether or not subplots on the lower half from the diagonal are displayed.

• showupperhalf – Determines whether or not subplots on the upper half from the diagonal are displayed.

• stream – plotly.graph_objects.splom.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.splom.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• xaxes – Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• yaxes – Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_streamtube(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Streamtube trace

Use a streamtube trace to visualize flow in a vector field. Specify a vector field using 6 1D arrays of equal length, 3 position arrays x, y and z and 3 vector component arrays u, v, and w. By default, the tubes’ starting positions will be cut from the vector field’s x-z plane at its minimum y value. To specify your own starting position, use attributes starts.x, starts.y and starts.z. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w).

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.

• cauto – Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.streamtube.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.streamtube.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables tubex, tubey, tubez, tubeu, tubev, tubew, norm and divergence. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.streamtube.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.streamtube.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.streamtube.Lightposition instance or dict with compatible properties

• maxdisplayed – The maximum number of displayed segments in a streamtube.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• sizeref – The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.

• starts – plotly.graph_objects.streamtube.Starts instance or dict with compatible properties

• stream – plotly.graph_objects.streamtube.Stream instance or dict with compatible properties

• text – Sets a text element associated with this trace. If trace hoverinfo contains a “text” flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array text values.

• u – Sets the x components of the vector field.

• uhoverformat – Sets the hover text formatting rulefor u using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• usrc – Sets the source reference on Chart Studio Cloud for u.

• v – Sets the y components of the vector field.

• vhoverformat – Sets the hover text formatting rulefor v using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• vsrc – Sets the source reference on Chart Studio Cloud for v.

• w – Sets the z components of the vector field.

• whoverformat – Sets the hover text formatting rulefor w using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• wsrc – Sets the source reference on Chart Studio Cloud for w.

• x – Sets the x coordinates of the vector field.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates of the vector field.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates of the vector field.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_sunburst(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Sunburst trace

Visualize hierarchal data spanning outward radially from root to leaves. The sunburst sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

• branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

• count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.sunburst.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.sunburst.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• insidetextorientation – Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.

• labels – Sets the labels of each of the sectors.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• leaf – plotly.graph_objects.sunburst.Leaf instance or dict with compatible properties

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.sunburst.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

• marker – plotly.graph_objects.sunburst.Marker instance or dict with compatible properties

• maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

• parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

• parentssrc – Sets the source reference on Chart Studio Cloud for parents.

• root – plotly.graph_objects.sunburst.Root instance or dict with compatible properties

• rotation – Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o’clock.

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.sunburst.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_surface(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Surface trace

The data the describes the coordinates of the surface is set in z. Data in z should be a 2D list. Coordinates in x and y can either be 1D lists or 2D lists (e.g. to graph parametric surfaces). If not provided in x and y, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the z values by default. For custom color scales, use surfacecolor which should be a 2D list, where its bounds can be controlled using cmin and cmax.

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.

• cauto – Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmin must be set as well.

• cmid – Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when cauto is false.

• cmin – Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.surface.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in.

• contours – plotly.graph_objects.surface.Contours instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• hidesurface – Determines whether or not a surface is drawn. For example, set hidesurface to False contours.x.show to True and contours.y.show to True to draw a wire frame plot.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.surface.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.surface.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.surface.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.surface.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

• opacityscale – Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The default is ‘uniform’.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• stream – plotly.graph_objects.surface.Stream instance or dict with compatible properties

• surfacecolor – Sets the surface color values, used for setting a color scale independent of z.

• surfacecolorsrc – Sets the source reference on Chart Studio Cloud for surfacecolor.

• text – Sets the text elements associated with each z value. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the x coordinates.

• xcalendar – Sets the calendar system to use with x date data.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• ycalendar – Sets the calendar system to use with y date data.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the z coordinates.

• zcalendar – Sets the calendar system to use with z date data.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_table(cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Table trace

Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column- major order, ie. the grid is represented as a vector of column vectors.

Parameters

• cells – plotly.graph_objects.table.Cells instance or dict with compatible properties

• columnorder – Specifies the rendered order of the data columns; for example, a value 2 at position 0 means that column index 0 in the data will be rendered as the third column, as columns have an index base of zero.

• columnordersrc – Sets the source reference on Chart Studio Cloud for columnorder.

• columnwidth – The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

• columnwidthsrc – Sets the source reference on Chart Studio Cloud for columnwidth.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.table.Domain instance or dict with compatible properties

• header – plotly.graph_objects.table.Header instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.table.Hoverlabel instance or dict with compatible properties

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.table.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• stream – plotly.graph_objects.table.Stream instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_trace(trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) → plotly.graph_objects._figurewidget.FigureWidget

Add a trace to the figure

Parameters

• trace (BaseTraceType or dict) –

  Either:

  • An instances of a trace classe from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar)

  • or a dicts where:

    • The ‘type’ property specifies the trace type (e.g. ‘scatter’, ‘bar’, ‘area’, etc.). If the dict has no ‘type’ property then ‘scatter’ is assumed.

    • All remaining properties are passed to the constructor of the specified trace type.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots. If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots. If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

  • The trace argument is a 2D cartesian trace (scatter, bar, etc.)

• exclude_empty_subplots (boolean) – If True, the trace will not be added to subplots that don’t already have traces.

Returns

The Figure that add_trace was called on

Return type

BaseFigure

Examples

>>> from plotly import subplots
>>> import plotly.graph_objects as go

Add two Scatter traces to a figure

>>> fig = go.Figure()
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) 
Figure(...)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) 
Figure(...)

Add two Scatter traces to vertically stacked subplots

>>> fig = subplots.make_subplots(rows=2)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) 
Figure(...)
>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) 
Figure(...)

add_traces(data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) → plotly.graph_objects._figurewidget.FigureWidget

Add traces to the figure

Parameters

• data (list[BaseTraceType or dict]) –

  A list of trace specifications to be added. Trace specifications may be either:

  • Instances of trace classes from the plotly.graph_objects package (e.g plotly.graph_objects.Scatter, plotly.graph_objects.Bar)

  • Dicts where:

    • The ‘type’ property specifies the trace type (e.g. ‘scatter’, ‘bar’, ‘area’, etc.). If the dict has no ‘type’ property then ‘scatter’ is assumed.

    • All remaining properties are passed to the constructor of the specified trace type.

• rows (None, list[int], or int (default None)) – List of subplot row indexes (starting from 1) for the traces to be added. Only valid if figure was created using plotly.tools.make_subplots If a single integer is passed, all traces will be added to row number

• cols (None or list[int] (default None)) – List of subplot column indexes (starting from 1) for the traces to be added. Only valid if figure was created using plotly.tools.make_subplots If a single integer is passed, all traces will be added to column number

secondary_ys: None or list[boolean] (default None)

List of secondary_y booleans for traces to be added. See the docstring for add_trace for more info.

exclude_empty_subplots: boolean

If True, the trace will not be added to subplots that don’t already have traces.

Returns

The Figure that add_traces was called on

Return type

BaseFigure

Examples

>>> from plotly import subplots
>>> import plotly.graph_objects as go

Add two Scatter traces to a figure

>>> fig = go.Figure()
>>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
...                 go.Scatter(x=[1,2,3], y=[2,1,2])]) 
Figure(...)

Add two Scatter traces to vertically stacked subplots

>>> fig = subplots.make_subplots(rows=2)
>>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
...                 go.Scatter(x=[1,2,3], y=[2,1,2])],
...                 rows=[1, 2], cols=[1, 1]) 
Figure(...)

add_treemap(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Treemap trace

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The treemap sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

• branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

• count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• domain – plotly.graph_objects.treemap.Domain instance or dict with compatible properties

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.treemap.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• insidetextfont – Sets the font used for textinfo lying inside the sector.

• labels – Sets the labels of each of the sectors.

• labelssrc – Sets the source reference on Chart Studio Cloud for labels.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgrouptitle – plotly.graph_objects.treemap.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

• marker – plotly.graph_objects.treemap.Marker instance or dict with compatible properties

• maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the trace.

• outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

• parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

• parentssrc – Sets the source reference on Chart Studio Cloud for parents.

• pathbar – plotly.graph_objects.treemap.Pathbar instance or dict with compatible properties

• root – plotly.graph_objects.treemap.Root instance or dict with compatible properties

• sort – Determines whether or not the sectors are reordered from largest to smallest.

• stream – plotly.graph_objects.treemap.Stream instance or dict with compatible properties

• text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textfont – Sets the font used for textinfo.

• textinfo – Determines which trace information appear on the graph.

• textposition – Sets the positions of the text elements.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• tiling – plotly.graph_objects.treemap.Tiling instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

• valuessrc – Sets the source reference on Chart Studio Cloud for values.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_violin(alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Violin trace

In vertical (horizontal) violin plots, statistics are computed using y (x) values. By supplying an x (y) array, one violin per distinct x (y) value is drawn If no x (y) list is provided, a single violin is drawn. That violin position is then positioned with with name or with x0 (y0) if provided.

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.

• bandwidth – Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman’s rule of thumb.

• box – plotly.graph_objects.violin.Box instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

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

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.violin.Hoverlabel instance or dict with compatible properties

• hoveron – Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• jitter – Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.violin.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• line – plotly.graph_objects.violin.Line instance or dict with compatible properties

• marker – plotly.graph_objects.violin.Marker instance or dict with compatible properties

• meanline – plotly.graph_objects.violin.Meanline instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute scalegroup (please see its description for details).

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• opacity – Sets the opacity of the trace.

• orientation – Sets the orientation of the violin(s). If “v” (“h”), the distribution is visualized along the vertical (horizontal).

• pointpos – Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

• points – If “outliers”, only the sample points lying outside the whiskers are shown If “suspectedoutliers”, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all sample points are shown If False, only the violins are shown with no sample points. Defaults to “suspectedoutliers” when marker.outliercolor or marker.line.outliercolor is set, otherwise defaults to “outliers”.

• quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 quartiles. The “linear” method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

• scalegroup – If there are multiple violins that should be sized according to to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin’s width is undefined, scalegroup will default to the trace’s name. In this case, violins with the same names will be linked together

• scalemode – Sets the metric by which the width of each violin is determined. “width” means each violin has the same (max) width “count” means the violins are scaled by the number of sample points making up each violin.

• selected – plotly.graph_objects.violin.Selected instance or dict with compatible properties

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• side – Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under “overlay” mode, where one trace has side set to “positive” and the other to “negative”.

• span – Sets the span in data space for which the density function will be computed. Has an effect only when spanmode is set to “manual”.

• spanmode – Sets the method by which the span in data space where the density function will be computed. “soft” means the span goes from the sample’s minimum value minus two bandwidths to the sample’s maximum value plus two bandwidths. “hard” means the span goes from the sample’s minimum to its maximum value. For custom span settings, use mode “manual” and fill in the span attribute.

• stream – plotly.graph_objects.violin.Stream instance or dict with compatible properties

• text – Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• unselected – plotly.graph_objects.violin.Unselected instance or dict with compatible properties

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

• x – Sets the x sample data or coordinates. See overview for more info.

• x0 – Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y sample data or coordinates. See overview for more info.

• y0 – Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

add_vline(x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a vertical line to a plot or subplot that extends infinitely in the y-dimension.

Parameters

• x (float or int) – A number representing the x coordinate of the vertical line.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the line. Example positions are “bottom left”, “right top”, “right”, “bottom”. If an annotation is added but annotation_position is not specified, this defaults to “top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_volume(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Volume trace

Draws volume trace between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the value, x, y and z of every vertex of a uniform or non- uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace.

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.

• caps – plotly.graph_objects.volume.Caps instance or dict with compatible properties

• cauto – Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

• cmax – Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

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

• cmin – Sets the lower bound of the color domain. Value should have the same units as value and if set, cmax must be set as well.

• coloraxis – Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar – plotly.graph_objects.volume.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• contour – plotly.graph_objects.volume.Contour instance or dict with compatible properties

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.volume.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Same as text.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• isomax – Sets the maximum boundary for iso-surface plot.

• isomin – Sets the minimum boundary for iso-surface plot.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – plotly.graph_objects.volume.Legendgrouptitle instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• lighting – plotly.graph_objects.volume.Lighting instance or dict with compatible properties

• lightposition – plotly.graph_objects.volume.Lightposition instance or dict with compatible properties

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• opacity – Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

• opacityscale – Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The default is ‘uniform’.

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

• scene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to layout.scene. If “scene2”, the (x,y,z) coordinates refer to layout.scene2, and so on.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• showscale – Determines whether or not a colorbar is displayed for this trace.

• slices – plotly.graph_objects.volume.Slices instance or dict with compatible properties

• spaceframe – plotly.graph_objects.volume.Spaceframe instance or dict with compatible properties

• stream – plotly.graph_objects.volume.Stream instance or dict with compatible properties

• surface – plotly.graph_objects.volume.Surface instance or dict with compatible properties

• text – Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• value – Sets the 4th dimension (value) of the vertices.

• valuehoverformat – Sets the hover text formatting rulefor value using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d 3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

• valuesrc – Sets the source reference on Chart Studio Cloud for value.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x – Sets the X coordinates of the vertices on X axis.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the Y coordinates of the vertices on Y axis.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• z – Sets the Z coordinates of the vertices on Z axis.

• zhoverformat – Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

• zsrc – Sets the source reference on Chart Studio Cloud for z.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

Returns

Return type

FigureWidget

add_vrect(x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a rectangle to a plot or subplot that extends infinitely in the y-dimension.

Parameters

• x0 (float or int) – A number representing the x coordinate of one side of the rectangle.

• x1 (float or int) – A number representing the x coordinate of the other side of the rectangle.

• exclude_empty_subplots (Boolean) – If True (default) do not place the shape on subplots that have no data plotted on them.

• row (None, int or 'all') – Subplot row for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• col (None, int or 'all') – Subplot column for shape indexed starting at 1. If ‘all’, addresses all rows in the specified column(s). If both row and col are None, addresses the first subplot if subplots exist, or the only plot. By default is “all”.

• annotation (dict or plotly.graph_objects.layout.Annotation. If dict(),) – it is interpreted as describing an annotation. The annotation is placed relative to the shape based on annotation_position (see below) unless its x or y value has been specified for the annotation passed here. xref and yref are always the same as for the added shape and cannot be overridden.

• annotation_position (a string containing optionally ["inside", "outside"], ["top", "bottom"]) – and [“left”, “right”] specifying where the text should be anchored to on the rectangle. Example positions are “outside top left”, “inside bottom”, “right”, “inside left”, “inside” (“outside” is not supported). If an annotation is added but annotation_position is not specified this defaults to “inside top right”.

• annotation_* (any parameters to go.layout.Annotation can be passed as) – keywords by prefixing them with “annotation_”. For example, to specify the annotation text “example” you can pass annotation_text=”example” as a keyword argument.

• **kwargs – Any named function parameters that can be passed to ‘add_shape’, except for x0, x1, y0, y1 or type.

add_waterfall(alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Add a new Waterfall trace

Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in y if orientation is set to “v” (the default) and the labels are set in x. By setting orientation to “h”, the roles are interchanged.

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

• cliponaxis – Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

• connector – plotly.graph_objects.waterfall.Connector instance or dict with compatible properties

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

• customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

• customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.

• decreasing – plotly.graph_objects.waterfall.Decreasing instance or dict with compatible properties

• dx – Sets the x coordinate step. See x0 for more info.

• dy – Sets the y coordinate step. See y0 for more info.

• hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

• hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.

• hoverlabel – plotly.graph_objects.waterfall.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta and final. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.

• hovertext – Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

• hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.

• ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc – Sets the source reference on Chart Studio Cloud for ids.

• increasing – plotly.graph_objects.waterfall.Increasing instance or dict with compatible properties

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

• insidetextfont – Sets the font used for text lying inside the bar.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

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

• legendgrouptitle – :class:`plotly.graph_objects.waterfall.Legendgrouptitle ` instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• measure – An array containing types of values. By default the values are considered as ‘relative’. However; it is possible to use ‘total’ to compute the sums. Also ‘absolute’ could be applied to reset the computed total or to declare an initial value where needed.

• measuresrc – Sets the source reference on Chart Studio Cloud for measure.

• meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

• metasrc – Sets the source reference on Chart Studio Cloud for meta.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• offset – Shifts the position where the bar is drawn (in position axis units). In “group” barmode, traces that set “offset” will be excluded and drawn in “overlay” mode instead.

• offsetgroup – Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

• offsetsrc – Sets the source reference on Chart Studio Cloud for offset.

• opacity – Sets the opacity of the trace.

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

• outsidetextfont – Sets the font used for text lying outside the bar.

• selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

• showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

• stream – plotly.graph_objects.waterfall.Stream instance or dict with compatible properties

• text – Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

• textangle – Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With “auto” the texts may automatically be rotated to fit with the maximum size in bars.

• textfont – Sets the font used for text.

• textinfo – Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

• textposition – Specifies the location of the text. “inside” positions text inside, next to the bar end (rotated and scaled if needed). “outside” positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. “auto” tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If “none”, no text appears.

• textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition.

• textsrc – Sets the source reference on Chart Studio Cloud for text.

• texttemplate – Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta, final and label.

• texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.

• totals – plotly.graph_objects.waterfall.Totals instance or dict with compatible properties

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

• uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

• visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• width – Sets the bar width (in position axis units).

• widthsrc – Sets the source reference on Chart Studio Cloud for width.

• x – Sets the x coordinates.

• x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

• xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

• xhoverformat – Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

• xperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• xperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• xperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

• xsrc – Sets the source reference on Chart Studio Cloud for x.

• y – Sets the y coordinates.

• y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

• yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

• yhoverformat – Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

• yperiod – Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

• yperiod0 – Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• yperiodalignment – Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

• ysrc – Sets the source reference on Chart Studio Cloud for y.

• zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

• row ('all', int or None (default)) – Subplot row index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all rows in the specified column(s).

• col ('all', int or None (default)) – Subplot col index (starting from 1) for the trace to be added. Only valid if figure was created using plotly.tools.make_subplots.If ‘all’, addresses all columns in the specified row(s).

• secondary_y (boolean or None (default None)) –

  If True, associate this trace with the secondary y-axis of the subplot at the specified row and col. Only valid if all of the following conditions are satisfied:

  • The figure was created using plotly.subplots.make_subplots.

  • The row and col arguments are not None

  • The subplot at the specified row and col has type xy (which is the default) and secondary_y True. These properties are specified in the specs argument to make_subplots. See the make_subplots docstring for more info.

Returns

Return type

FigureWidget

for_each_annotation(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all annotations that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single annotation object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotations that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotations that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select annotations associated with the secondary y-axis of the subplot.

  • If False, only select annotations associated with the primary y-axis of the subplot.

  • If None (the default), do not filter annotations based on secondary y-axis.

  To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_coloraxis(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all coloraxis objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single coloraxis object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_geo(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all geo objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single geo object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_layout_image(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all images that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single image object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those images that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those images that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select images associated with the secondary y-axis of the subplot.

  • If False, only select images associated with the primary y-axis of the subplot.

  • If None (the default), do not filter images based on secondary y-axis.

  To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_legend(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all legend objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single legend object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_map(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all map objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single map object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_mapbox(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all mapbox objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single mapbox object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_polar(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all polar objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single polar object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_scene(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all scene objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single scene object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_selection(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all selections that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single selection object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selections that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selections that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select selections associated with the secondary y-axis of the subplot.

  • If False, only select selections associated with the primary y-axis of the subplot.

  • If None (the default), do not filter selections based on secondary y-axis.

  To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_shape(fn, selector=None, row=None, col=None, secondary_y=None)

Apply a function to all shapes that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single shape object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shapes that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shapes that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select shapes associated with the secondary y-axis of the subplot.

  • If False, only select shapes associated with the primary y-axis of the subplot.

  • If None (the default), do not filter shapes based on secondary y-axis.

  To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_smith(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all smith objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single smith object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_ternary(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all ternary objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single ternary object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_trace(fn, selector=None, row=None, col=None, secondary_y=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all traces that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single trace object.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all traces are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each trace and those for which the function returned True will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• col (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select traces associated with the secondary y-axis of the subplot.

  • If False, only select traces associated with the primary y-axis of the subplot.

  • If None (the default), do not filter traces based on secondary y-axis.

  To select traces by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the Figure object that the method was called on

Return type

self

for_each_xaxis(fn, selector=None, row=None, col=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all xaxis objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single xaxis object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

for_each_yaxis(fn, selector=None, row=None, col=None, secondary_y=None) → plotly.graph_objects._figurewidget.FigureWidget

Apply a function to all yaxis objects that satisfy the specified selection criteria

Parameters

• fn – Function that inputs a single yaxis object.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select yaxis objects associated with the secondary y-axis of the subplot.

  • If False, only select yaxis objects associated with the primary y-axis of the subplot.

  • If None (the default), do not filter yaxis objects based on a secondary y-axis condition.

  To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

select_annotations(selector=None, row=None, col=None, secondary_y=None)

Select annotations from a particular subplot cell and/or annotations that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select annotations associated with the secondary y-axis of the subplot.

  • If False, only select annotations associated with the primary y-axis of the subplot.

  • If None (the default), do not filter annotations based on secondary y-axis.

  To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the annotations that satisfy all of the specified selection criteria

Return type

generator

select_coloraxes(selector=None, row=None, col=None)

Select coloraxis subplot objects from a particular subplot cell and/or coloraxis subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

Returns

Generator that iterates through all of the coloraxis objects that satisfy all of the specified selection criteria

Return type

generator

select_geos(selector=None, row=None, col=None)

Select geo subplot objects from a particular subplot cell and/or geo subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

Returns

Generator that iterates through all of the geo objects that satisfy all of the specified selection criteria

Return type

generator

select_layout_images(selector=None, row=None, col=None, secondary_y=None)

Select images from a particular subplot cell and/or images that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select images associated with the secondary y-axis of the subplot.

  • If False, only select images associated with the primary y-axis of the subplot.

  • If None (the default), do not filter images based on secondary y-axis.

  To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the images that satisfy all of the specified selection criteria

Return type

generator

select_legends(selector=None, row=None, col=None)

Select legend subplot objects from a particular subplot cell and/or legend subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

Returns

Generator that iterates through all of the legend objects that satisfy all of the specified selection criteria

Return type

generator

select_mapboxes(selector=None, row=None, col=None)

Select mapbox subplot objects from a particular subplot cell and/or mapbox subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

Returns

Generator that iterates through all of the mapbox objects that satisfy all of the specified selection criteria

Return type

generator

select_maps(selector=None, row=None, col=None)

Select map subplot objects from a particular subplot cell and/or map subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

Returns

Generator that iterates through all of the map objects that satisfy all of the specified selection criteria

Return type

generator

select_polars(selector=None, row=None, col=None)

Select polar subplot objects from a particular subplot cell and/or polar subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

Returns

Generator that iterates through all of the polar objects that satisfy all of the specified selection criteria

Return type

generator

select_scenes(selector=None, row=None, col=None)

Select scene subplot objects from a particular subplot cell and/or scene subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

Returns

Generator that iterates through all of the scene objects that satisfy all of the specified selection criteria

Return type

generator

select_selections(selector=None, row=None, col=None, secondary_y=None)

Select selections from a particular subplot cell and/or selections that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select selections associated with the secondary y-axis of the subplot.

  • If False, only select selections associated with the primary y-axis of the subplot.

  • If None (the default), do not filter selections based on secondary y-axis.

  To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the selections that satisfy all of the specified selection criteria

Return type

generator

select_shapes(selector=None, row=None, col=None, secondary_y=None)

Select shapes from a particular subplot cell and/or shapes that satisfy custom selection criteria.

Parameters

• selector (dict, function, int, str, or None (default None)) – Dict to use as selection criteria. Annotations will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select shapes associated with the secondary y-axis of the subplot.

  • If False, only select shapes associated with the primary y-axis of the subplot.

  • If None (the default), do not filter shapes based on secondary y-axis.

  To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the shapes that satisfy all of the specified selection criteria

Return type

generator

select_smiths(selector=None, row=None, col=None)

Select smith subplot objects from a particular subplot cell and/or smith subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

Returns

Generator that iterates through all of the smith objects that satisfy all of the specified selection criteria

Return type

generator

select_ternaries(selector=None, row=None, col=None)

Select ternary subplot objects from a particular subplot cell and/or ternary subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

Returns

Generator that iterates through all of the ternary objects that satisfy all of the specified selection criteria

Return type

generator

select_xaxes(selector=None, row=None, col=None)

Select xaxis subplot objects from a particular subplot cell and/or xaxis subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

Returns

Generator that iterates through all of the xaxis objects that satisfy all of the specified selection criteria

Return type

generator

select_yaxes(selector=None, row=None, col=None, secondary_y=None)

Select yaxis subplot objects from a particular subplot cell and/or yaxis subplot objects that satisfy custom selection criteria.

Parameters

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.

• row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select yaxis objects associated with the secondary y-axis of the subplot.

  • If False, only select yaxis objects associated with the primary y-axis of the subplot.

  • If None (the default), do not filter yaxis objects based on a secondary y-axis condition.

  To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

Returns

Generator that iterates through all of the yaxis objects that satisfy all of the specified selection criteria

Return type

generator

set_subplots(rows=None, cols=None, **make_subplots_args) → plotly.graph_objects._figurewidget.FigureWidget

Add subplots to this figure. If the figure already contains subplots, then this throws an error. Accepts any keyword arguments that plotly.subplots.make_subplots accepts.

update(dict1=None, overwrite=False, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Update the properties of the figure with a dict and/or with keyword arguments.

This recursively updates the structure of the figure object with the values in the input dict / keyword arguments.

Parameters

• dict1 (dict) – Dictionary of properties to be updated

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• kwargs – Keyword/value pair of properties to be updated

Examples

>>> import plotly.graph_objects as go
>>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
>>> fig.update(data=[{'y': [4, 5, 6]}]) 
Figure(...)
>>> fig.to_plotly_json() 
    {'data': [{'type': 'scatter',
       'uid': 'e86a7c7a-346a-11e8-8aa8-a0999b0c017b',
       'y': array([4, 5, 6], dtype=int32)}],
     'layout': {}}

>>> fig = go.Figure(layout={'xaxis':
...                         {'color': 'green',
...                          'range': [0, 1]}})
>>> fig.update({'layout': {'xaxis': {'color': 'pink'}}}) 
Figure(...)
>>> fig.to_plotly_json() 
    {'data': [],
     'layout': {'xaxis':
                {'color': 'pink',
                 'range': [0, 1]}}}

Returns

Updated figure

Return type

BaseFigure

update_annotations(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all annotations that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all annotations that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all annotations are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each annotation and those for which the function returned True will be in the selection. If an int N, the Nth annotation matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• col (int or None (default None)) – Subplot row and column index of annotations to select. To select annotations by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those annotation that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all annotations are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select annotations associated with the secondary y-axis of the subplot.

  • If False, only select annotations associated with the primary y-axis of the subplot.

  • If None (the default), do not filter annotations based on secondary y-axis.

  To select annotations by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected annotation. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_coloraxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all coloraxis objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all coloraxis objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.

• **kwargs – Additional property updates to apply to each selected coloraxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_geos(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all geo objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all geo objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. geo objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all geo objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each geo and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• col (int or None (default None)) – Subplot row and column index of geo objects to select. To select geo objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all geo objects are selected.

• **kwargs – Additional property updates to apply to each selected geo object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_layout(dict1=None, overwrite=False, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Update the properties of the figure’s layout with a dict and/or with keyword arguments.

This recursively updates the structure of the original layout with the values in the input dict / keyword arguments.

Parameters

• dict1 (dict) – Dictionary of properties to be updated

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• kwargs – Keyword/value pair of properties to be updated

Returns

The Figure object that the update_layout method was called on

Return type

BaseFigure

update_layout_images(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all images that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all images that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all images are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each image and those for which the function returned True will be in the selection. If an int N, the Nth image matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• col (int or None (default None)) – Subplot row and column index of images to select. To select images by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those image that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all images are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select images associated with the secondary y-axis of the subplot.

  • If False, only select images associated with the primary y-axis of the subplot.

  • If None (the default), do not filter images based on secondary y-axis.

  To select images by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected image. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_legends(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all legend objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all legend objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. legend objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all legend objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each legend and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• col (int or None (default None)) – Subplot row and column index of legend objects to select. To select legend objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all legend objects are selected.

• **kwargs – Additional property updates to apply to each selected legend object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_mapboxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all mapbox objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all mapbox objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. mapbox objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all mapbox objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each mapbox and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• col (int or None (default None)) – Subplot row and column index of mapbox objects to select. To select mapbox objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all mapbox objects are selected.

• **kwargs – Additional property updates to apply to each selected mapbox object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_maps(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all map objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all map objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. map objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all map objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each map and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• col (int or None (default None)) – Subplot row and column index of map objects to select. To select map objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all map objects are selected.

• **kwargs – Additional property updates to apply to each selected map object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_polars(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all polar objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all polar objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. polar objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all polar objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each polar and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• col (int or None (default None)) – Subplot row and column index of polar objects to select. To select polar objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all polar objects are selected.

• **kwargs – Additional property updates to apply to each selected polar object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_scenes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all scene objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all scene objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. scene objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all scene objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each scene and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• col (int or None (default None)) – Subplot row and column index of scene objects to select. To select scene objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all scene objects are selected.

• **kwargs – Additional property updates to apply to each selected scene object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_selections(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all selections that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all selections that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all selections are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each selection and those for which the function returned True will be in the selection. If an int N, the Nth selection matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• col (int or None (default None)) – Subplot row and column index of selections to select. To select selections by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those selection that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all selections are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select selections associated with the secondary y-axis of the subplot.

  • If False, only select selections associated with the primary y-axis of the subplot.

  • If None (the default), do not filter selections based on secondary y-axis.

  To select selections by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected selection. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_shapes(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all shapes that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all shapes that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all shapes are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each shape and those for which the function returned True will be in the selection. If an int N, the Nth shape matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• col (int or None (default None)) – Subplot row and column index of shapes to select. To select shapes by row and column, the Figure must have been created using plotly.subplots.make_subplots. To select only those shape that are in paper coordinates, set row and col to the string ‘paper’. If None (the default), all shapes are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select shapes associated with the secondary y-axis of the subplot.

  • If False, only select shapes associated with the primary y-axis of the subplot.

  • If None (the default), do not filter shapes based on secondary y-axis.

  To select shapes by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected shape. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_smiths(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all smith objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all smith objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. smith objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all smith objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each smith and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• col (int or None (default None)) – Subplot row and column index of smith objects to select. To select smith objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all smith objects are selected.

• **kwargs – Additional property updates to apply to each selected smith object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_ternaries(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all ternary objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all ternary objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. ternary objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all ternary objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each ternary and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• col (int or None (default None)) – Subplot row and column index of ternary objects to select. To select ternary objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all ternary objects are selected.

• **kwargs – Additional property updates to apply to each selected ternary object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_traces(patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all traces that satisfy the specified selection criteria

Parameters

• patch (dict or None (default None)) – Dictionary of property updates to be applied to all traces that satisfy the selection criteria.

• selector (dict, function, int, str or None (default None)) – Dict to use as selection criteria. Traces will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all traces are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each trace and those for which the function returned True will be in the selection. If an int N, the Nth trace matching row and col will be selected (N can be negative). If a string S, the selector is equivalent to dict(type=S).

• row (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• col (int or None (default None)) – Subplot row and column index of traces to select. To select traces by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all traces are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select traces associated with the secondary y-axis of the subplot.

  • If False, only select traces associated with the primary y-axis of the subplot.

  • If None (the default), do not filter traces based on secondary y-axis.

  To select traces by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• **kwargs – Additional property updates to apply to each selected trace. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

update_xaxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all xaxis objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all xaxis objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. xaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all xaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each xaxis and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of xaxis objects to select. To select xaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all xaxis objects are selected.

• **kwargs – Additional property updates to apply to each selected xaxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

update_yaxes(patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) → plotly.graph_objects._figurewidget.FigureWidget

Perform a property update operation on all yaxis objects that satisfy the specified selection criteria

Parameters

• patch (dict) – Dictionary of property updates to be applied to all yaxis objects that satisfy the selection criteria.

• selector (dict, function, or None (default None)) – Dict to use as selection criteria. yaxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all yaxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each yaxis and those for which the function returned True will be in the selection.

• overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.

• row (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• col (int or None (default None)) – Subplot row and column index of yaxis objects to select. To select yaxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all yaxis objects are selected.

• secondary_y (boolean or None (default None)) –

  • If True, only select yaxis objects associated with the secondary y-axis of the subplot.

  • If False, only select yaxis objects associated with the primary y-axis of the subplot.

  • If None (the default), do not filter yaxis objects based on a secondary y-axis condition.

  To select yaxis objects by secondary y-axis, the Figure must have been created using plotly.subplots.make_subplots. See the docstring for the specs argument to make_subplots for more info on creating subplots with secondary y-axes.

• **kwargs – Additional property updates to apply to each selected yaxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.

Returns

Returns the FigureWidget object that the method was called on

Return type

self

class plotly.graph_objects.Font(*args, **kwargs)

Bases: dict

plotly.graph_objects.Font is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.Font

• plotly.graph_objects.layout.hoverlabel.Font

• etc.

class plotly.graph_objects.Frame(arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)

Bases: plotly.basedatatypes.BaseFrameHierarchyType

property baseframe

The name of the frame into which this frame’s properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames.

The ‘baseframe’ 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 data

A list of traces this frame modifies. The format is identical to the normal trace definition.

Returns

Return type

Any

property group

An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames.

The ‘group’ 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 layout

Layout properties which this frame modifies. The format is identical to the normal layout definition.

Returns

Return type

Any

property name

A label by which to identify the frame

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 traces

A list of trace indices that identify the respective traces in the data attribute

The ‘traces’ property accepts values of any type

Returns

Return type

Any

class plotly.graph_objects.Frames(*args, **kwargs)

Bases: list

plotly.graph_objects.Frames is deprecated.

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

• plotly.graph_objects.Frame

class plotly.graph_objects.Funnel(arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 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 connector

The ‘connector’ property is an instance of Connector that may be specified as:

• An instance of plotly.graph_objects.funnel.Connector

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

Returns

Return type

plotly.graph_objects.funnel.Connector

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 hoverinfo

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘name’, ‘x’, ‘y’, ‘text’, ‘percent initial’, ‘percent previous’, ‘percent total’] joined with ‘+’ characters (e.g. ‘name+x’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.funnel.Hoverlabel

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

Returns

Return type

plotly.graph_objects.funnel.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious and percentTotal. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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

Returns

Return type

plotly.graph_objects.funnel.Insidetextfont

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.funnel.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.funnel.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property marker

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

• An instance of plotly.graph_objects.funnel.Marker

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

Returns

Return type

plotly.graph_objects.funnel.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 appears 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

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 funnels. With “v” (“h”), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only “y” array is presented or orientation is set to “v”. Also regarding graphs including only ‘horizontal’ funnels, “autorange” on the “y-axis” are set to “reversed”.

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

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

Returns

Return type

plotly.graph_objects.funnel.Outsidetextfont

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.funnel.Stream

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

Returns

Return type

plotly.graph_objects.funnel.Stream

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

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

Returns

Return type

plotly.graph_objects.funnel.Textfont

property textinfo

Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘percent initial’, ‘percent previous’, ‘percent total’, ‘value’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

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. If “none”, no text appears.

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious, percentTotal, label and value.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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]

Returns

Return type

int|float

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 xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.Funnelarea(arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property aspectratio

Sets the ratio between height and width

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

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

Returns

Return type

int|float

property baseratio

Sets the ratio between bottom length and maximum top length.

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

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

Returns

Return type

int|float

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 dlabel

Sets the label step. See label0 for more info.

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

• An int or float

Returns

Return type

int|float

property domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.funnelarea.Domain

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

Returns

Return type

plotly.graph_objects.funnelarea.Domain

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 [‘label’, ‘text’, ‘value’, ‘percent’, ‘name’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.funnelarea.Hoverlabel

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

Returns

Return type

plotly.graph_objects.funnelarea.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

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 insidetextfont

Sets the font used for textinfo lying inside the sector.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

• An instance of plotly.graph_objects.funnelarea.Insidetextfont

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

Returns

Return type

plotly.graph_objects.funnelarea.Insidetextfont

property label0

Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

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

• An int or float

Returns

Return type

int|float

property labels

Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

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

Returns

Return type

numpy.ndarray

property labelssrc

Sets the source reference on Chart Studio Cloud for labels.

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

Returns

Return type

str

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.funnelarea.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.funnelarea.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property marker

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

• An instance of plotly.graph_objects.funnelarea.Marker

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

Returns

Return type

plotly.graph_objects.funnelarea.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 appears 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 scalegroup

If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

The ‘scalegroup’ 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 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.funnelarea.Stream

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

Returns

Return type

plotly.graph_objects.funnelarea.Stream

property text

Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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

Returns

Return type

numpy.ndarray

property textfont

Sets the font used for textinfo.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.funnelarea.Textfont

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

Returns

Return type

plotly.graph_objects.funnelarea.Textfont

property textinfo

Determines which trace information appear on the graph.

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘value’, ‘percent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property textposition

Specifies the location of the textinfo.

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

• One of the following enumeration values:

  [‘inside’, ‘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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 title

The ‘title’ property is an instance of Title that may be specified as:

• An instance of plotly.graph_objects.funnelarea.Title

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

Returns

Return type

plotly.graph_objects.funnelarea.Title

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 values

Sets the values of the sectors. If omitted, we count occurrences of each label.

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

Returns

Return type

numpy.ndarray

property valuessrc

Sets the source reference on Chart Studio Cloud for values.

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

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

class plotly.graph_objects.Heatmap(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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.heatmap.ColorBar

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

Returns

Return type

plotly.graph_objects.heatmap.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array and zsmooth is not false; otherwise it is defaulted to false.

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

Returns

Return type

bool

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 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.heatmap.Hoverlabel

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

Returns

Return type

plotly.graph_objects.heatmap.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.heatmap.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.heatmap.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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 appears 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 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.heatmap.Stream

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

Returns

Return type

plotly.graph_objects.heatmap.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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.heatmap.Textfont

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

Returns

Return type

plotly.graph_objects.heatmap.Textfont

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

The ‘texttemplate’ 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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xgap

Sets the horizontal gap (in pixels) between bricks.

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

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

Returns

Return type

int|float

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property ygap

Sets the vertical gap (in pixels) between bricks.

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

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

Returns

Return type

int|float

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

property zsmooth

Picks a smoothing algorithm use to smooth z data.

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

• One of the following enumeration values:

  [‘fast’, ‘best’, False]

Returns

Return type

Any

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.Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 autobinx

since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

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

Returns

Return type

bool

Type

Obsolete

property autobiny

since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

Returns

Return type

bool

Type

Obsolete

property bingroup

Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same “orientation” under barmode “stack”, “relative” and “group” are forced into the same bingroup, Using bingroup, traces under barmode “overlay” and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same bingroup

The ‘bingroup’ 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 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 cumulative

The ‘cumulative’ property is an instance of Cumulative that may be specified as:

• An instance of plotly.graph_objects.histogram.Cumulative

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

Returns

Return type

plotly.graph_objects.histogram.Cumulative

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 error_x

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

• An instance of plotly.graph_objects.histogram.ErrorX

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

Returns

Return type

plotly.graph_objects.histogram.ErrorX

property error_y

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

• An instance of plotly.graph_objects.histogram.ErrorY

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

Returns

Return type

plotly.graph_objects.histogram.ErrorY

property histfunc

Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

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

• One of the following enumeration values:

  [‘count’, ‘sum’, ‘avg’, ‘min’, ‘max’]

Returns

Return type

Any

property histnorm

Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

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

• One of the following enumeration values:

  [‘’, ‘percent’, ‘probability’, ‘density’, ‘probability density’]

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 [‘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.histogram.Hoverlabel

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

Returns

Return type

plotly.graph_objects.histogram.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable binNumber Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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

Returns

Return type

plotly.graph_objects.histogram.Insidetextfont

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.histogram.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.histogram.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property marker

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

• An instance of plotly.graph_objects.histogram.Marker

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

Returns

Return type

plotly.graph_objects.histogram.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 appears 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 nbinsx

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

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

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

Returns

Return type

int

property nbinsy

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

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

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

Returns

Return type

int

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

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

Returns

Return type

plotly.graph_objects.histogram.Outsidetextfont

property selected

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

• An instance of plotly.graph_objects.histogram.Selected

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

Returns

Return type

plotly.graph_objects.histogram.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.histogram.Stream

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

Returns

Return type

plotly.graph_objects.histogram.Stream

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 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 text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.histogram.Textfont

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

Returns

Return type

plotly.graph_objects.histogram.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. If “none”, no text appears.

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

• One of the following enumeration values:

  [‘inside’, ‘outside’, ‘auto’, ‘none’]

Returns

Return type

Any

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label and value.

The ‘texttemplate’ 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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

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

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 unselected

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

• An instance of plotly.graph_objects.histogram.Unselected

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

Returns

Return type

plotly.graph_objects.histogram.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 x

Sets the sample data to be binned on the x axis.

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

Returns

Return type

numpy.ndarray

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 xbins

The ‘xbins’ property is an instance of XBins that may be specified as:

• An instance of plotly.graph_objects.histogram.XBins

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

Returns

Return type

plotly.graph_objects.histogram.XBins

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 sample data to be binned on the y axis.

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

Returns

Return type

numpy.ndarray

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 ybins

The ‘ybins’ property is an instance of YBins that may be specified as:

• An instance of plotly.graph_objects.histogram.YBins

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

Returns

Return type

plotly.graph_objects.histogram.YBins

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.Histogram2d(arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property autobinx

since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

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

Returns

Return type

bool

Type

Obsolete

property autobiny

since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

Returns

Return type

bool

Type

Obsolete

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 bingroup

Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

The ‘bingroup’ 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

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.histogram2d.ColorBar

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

Returns

Return type

plotly.graph_objects.histogram2d.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

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

Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

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

• One of the following enumeration values:

  [‘count’, ‘sum’, ‘avg’, ‘min’, ‘max’]

Returns

Return type

Any

property histnorm

Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

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

• One of the following enumeration values:

  [‘’, ‘percent’, ‘probability’, ‘density’, ‘probability density’]

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 [‘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.histogram2d.Hoverlabel

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

Returns

Return type

plotly.graph_objects.histogram2d.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.histogram2d.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.histogram2d.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property marker

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

• An instance of plotly.graph_objects.histogram2d.Marker

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

Returns

Return type

plotly.graph_objects.histogram2d.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 appears 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 nbinsx

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

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

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

Returns

Return type

int

property nbinsy

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

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

• An int (or float that will be cast to an int) in the interval [0, 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.histogram2d.Stream

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

Returns

Return type

plotly.graph_objects.histogram2d.Stream

property textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.histogram2d.Textfont

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

Returns

Return type

plotly.graph_objects.histogram2d.Textfont

property texttemplate

Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z

The ‘texttemplate’ 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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

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

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

property x

Sets the sample data to be binned on the x axis.

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

Returns

Return type

numpy.ndarray

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 xbingroup

Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

The ‘xbingroup’ 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 xbins

The ‘xbins’ property is an instance of XBins that may be specified as:

• An instance of plotly.graph_objects.histogram2d.XBins

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

Returns

Return type

plotly.graph_objects.histogram2d.XBins

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xgap

Sets the horizontal gap (in pixels) between bricks.

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

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

Returns

Return type

int|float

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 sample data to be binned on the y axis.

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

Returns

Return type

numpy.ndarray

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 ybingroup

Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

The ‘ybingroup’ 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 ybins

The ‘ybins’ property is an instance of YBins that may be specified as:

• An instance of plotly.graph_objects.histogram2d.YBins

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

Returns

Return type

plotly.graph_objects.histogram2d.YBins

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property ygap

Sets the vertical gap (in pixels) between bricks.

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

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

Returns

Return type

int|float

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 aggregation 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

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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 zsmooth

Picks a smoothing algorithm use to smooth z data.

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

• One of the following enumeration values:

  [‘fast’, ‘best’, False]

Returns

Return type

Any

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.Histogram2dContour(arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, texttemplatefallback=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property autobinx

since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

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

Returns

Return type

bool

Type

Obsolete

property autobiny

since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

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

Returns

Return type

bool

Type

Obsolete

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 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 bingroup

Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

The ‘bingroup’ 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

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.histogram2dcontour.ColorBar

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property contours

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

• An instance of plotly.graph_objects.histogram2dcontour.Contours

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.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 histfunc

Specifies the binning function used for this histogram trace. If “count”, the histogram values are computed by counting the number of values lying inside each bin. If “sum”, “avg”, “min”, “max”, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

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

• One of the following enumeration values:

  [‘count’, ‘sum’, ‘avg’, ‘min’, ‘max’]

Returns

Return type

Any

property histnorm

Specifies the type of normalization used for this histogram trace. If “”, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If “percent” / “probability”, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If “density”, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

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

• One of the following enumeration values:

  [‘’, ‘percent’, ‘probability’, ‘density’, ‘probability density’]

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 [‘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.histogram2dcontour.Hoverlabel

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.histogram2dcontour.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property line

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

• An instance of plotly.graph_objects.histogram2dcontour.Line

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.Line

property marker

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

• An instance of plotly.graph_objects.histogram2dcontour.Marker

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.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 appears 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 nbinsx

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

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

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

Returns

Return type

int

property nbinsy

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

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

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

Returns

Return type

int

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.histogram2dcontour.Stream

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.Stream

property textfont

For this trace it only has an effect if coloring is set to “heatmap”. Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.histogram2dcontour.Textfont

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.Textfont

property texttemplate

For this trace it only has an effect if coloring is set to “heatmap”. Template string used for rendering the information text that appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

The ‘texttemplate’ 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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

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

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

property x

Sets the sample data to be binned on the x axis.

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

Returns

Return type

numpy.ndarray

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 xbingroup

Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

The ‘xbingroup’ 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 xbins

The ‘xbins’ property is an instance of XBins that may be specified as:

• An instance of plotly.graph_objects.histogram2dcontour.XBins

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.XBins

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 sample data to be binned on the y axis.

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

Returns

Return type

numpy.ndarray

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 ybingroup

Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

The ‘ybingroup’ 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 ybins

The ‘ybins’ property is an instance of YBins that may be specified as:

• An instance of plotly.graph_objects.histogram2dcontour.YBins

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

Returns

Return type

plotly.graph_objects.histogram2dcontour.YBins

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 aggregation 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

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

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.Histogram2dcontour(*args, **kwargs)

Bases: dict

plotly.graph_objects.Histogram2dcontour is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.Histogram2dContour

class plotly.graph_objects.Icicle(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property branchvalues

Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

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

• One of the following enumeration values:

  [‘remainder’, ‘total’]

Returns

Return type

Any

property count

Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

The ‘count’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘branches’, ‘leaves’] joined with ‘+’ characters (e.g. ‘branches+leaves’)

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 domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.icicle.Domain

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

Returns

Return type

plotly.graph_objects.icicle.Domain

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 [‘label’, ‘text’, ‘value’, ‘name’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.icicle.Hoverlabel

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

Returns

Return type

plotly.graph_objects.icicle.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

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 insidetextfont

Sets the font used for textinfo lying inside the sector.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

• An instance of plotly.graph_objects.icicle.Insidetextfont

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

Returns

Return type

plotly.graph_objects.icicle.Insidetextfont

property labels

Sets the labels of each of the sectors.

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

Returns

Return type

numpy.ndarray

property labelssrc

Sets the source reference on Chart Studio Cloud for labels.

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

Returns

Return type

str

property leaf

The ‘leaf’ property is an instance of Leaf that may be specified as:

• An instance of plotly.graph_objects.icicle.Leaf

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

Returns

Return type

plotly.graph_objects.icicle.Leaf

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.icicle.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.icicle.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property level

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

The ‘level’ property accepts values of any type

Returns

Return type

Any

property marker

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

• An instance of plotly.graph_objects.icicle.Marker

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

Returns

Return type

plotly.graph_objects.icicle.Marker

property maxdepth

Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

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 appears 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 outsidetextfont

Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:

• An instance of plotly.graph_objects.icicle.Outsidetextfont

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

Returns

Return type

plotly.graph_objects.icicle.Outsidetextfont

property parents

Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

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

Returns

Return type

numpy.ndarray

property parentssrc

Sets the source reference on Chart Studio Cloud for parents.

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

Returns

Return type

str

property pathbar

The ‘pathbar’ property is an instance of Pathbar that may be specified as:

• An instance of plotly.graph_objects.icicle.Pathbar

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

Returns

Return type

plotly.graph_objects.icicle.Pathbar

property root

The ‘root’ property is an instance of Root that may be specified as:

• An instance of plotly.graph_objects.icicle.Root

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

Returns

Return type

plotly.graph_objects.icicle.Root

property sort

Determines whether or not the sectors are reordered from largest to smallest.

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

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.icicle.Stream

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

Returns

Return type

plotly.graph_objects.icicle.Stream

property text

Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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

Returns

Return type

numpy.ndarray

property textfont

Sets the font used for textinfo.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.icicle.Textfont

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

Returns

Return type

plotly.graph_objects.icicle.Textfont

property textinfo

Determines which trace information appear on the graph.

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘value’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property textposition

Sets the positions of the text elements.

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

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

Returns

Return type

Any

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 tiling

The ‘tiling’ property is an instance of Tiling that may be specified as:

• An instance of plotly.graph_objects.icicle.Tiling

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

Returns

Return type

plotly.graph_objects.icicle.Tiling

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 values

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

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

Returns

Return type

numpy.ndarray

property valuessrc

Sets the source reference on Chart Studio Cloud for values.

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

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

class plotly.graph_objects.Image(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property colormodel

Color model used to map the numerical color components described in z into colors. If source is specified, this attribute will be set to rgba256 otherwise it defaults to rgb.

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

• One of the following enumeration values:

  [‘rgb’, ‘rgba’, ‘rgba256’, ‘hsl’, ‘hsla’]

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

Set the pixel’s horizontal size.

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

• An int or float

Returns

Return type

int|float

property dy

Set the pixel’s vertical size

The ‘dy’ 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 [‘x’, ‘y’, ‘z’, ‘color’, ‘name’, ‘text’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.image.Hoverlabel

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

Returns

Return type

plotly.graph_objects.image.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables z, color and colormodel. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.image.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.image.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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 appears 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 source

Specifies the data URI of the image to be visualized. The URI consists of “data:image/[<media subtype>][;base64],<data>”

The ‘source’ 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 stream

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

• An instance of plotly.graph_objects.image.Stream

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

Returns

Return type

plotly.graph_objects.image.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 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

property x0

Set the image’s x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2

The ‘x0’ property accepts values of any type

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 y0

Set the image’s y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.

The ‘y0’ property accepts values of any type

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 z

A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

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

Returns

Return type

numpy.ndarray

property zmax

Array defining the higher bound for each color component. Note

that the default value will depend on the colormodel. For the rgb colormodel, it is [255, 255, 255]. For the rgba colormodel, it is [255, 255, 255, 1]. For the rgba256 colormodel, it is [255, 255, 255, 255]. For the hsl colormodel, it is [360, 100, 100]. For the hsla colormodel, it is [360, 100, 100, 1].

The ‘zmax’ property is an info array that may be specified as:

• a list or tuple of 4 elements where:

0. The ‘zmax[0]’ property is a number and may be specified as:

   • An int or float

1. The ‘zmax[1]’ property is a number and may be specified as:

   • An int or float

2. The ‘zmax[2]’ property is a number and may be specified as:

   • An int or float

3. The ‘zmax[3]’ property is a number and may be specified as:

   • An int or float

   list

property zmin

Array defining the lower bound for each color component. Note

that the default value will depend on the colormodel. For the rgb colormodel, it is [0, 0, 0]. For the rgba colormodel, it is [0, 0, 0, 0]. For the rgba256 colormodel, it is [0, 0, 0, 0]. For the hsl colormodel, it is [0, 0, 0]. For the hsla colormodel, it is [0, 0, 0, 0].

The ‘zmin’ property is an info array that may be specified as:

• a list or tuple of 4 elements where:

0. The ‘zmin[0]’ property is a number and may be specified as:

   • An int or float

1. The ‘zmin[1]’ property is a number and may be specified as:

   • An int or float

2. The ‘zmin[2]’ property is a number and may be specified as:

   • An int or float

3. The ‘zmin[3]’ property is a number and may be specified as:

   • An int or float

   list

property zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

property zsmooth

Picks a smoothing algorithm used to smooth z data. This only applies for image traces that use the source attribute.

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

• One of the following enumeration values:

  [‘fast’, False]

Returns

Return type

Any

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.Indicator(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property align

Sets the horizontal alignment of the text within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

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

• One of the following enumeration values:

  [‘left’, ‘center’, ‘right’]

Returns

Return type

Any

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

The ‘delta’ property is an instance of Delta that may be specified as:

• An instance of plotly.graph_objects.indicator.Delta

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

Returns

Return type

plotly.graph_objects.indicator.Delta

property domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.indicator.Domain

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

Returns

Return type

plotly.graph_objects.indicator.Domain

property gauge

The gauge of the Indicator plot.

The ‘gauge’ property is an instance of Gauge that may be specified as:

• An instance of plotly.graph_objects.indicator.Gauge

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

Returns

Return type

plotly.graph_objects.indicator.Gauge

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.indicator.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.indicator.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

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 mode

Determines how the value is displayed on the graph. number displays the value numerically in text. delta displays the difference to a reference value in text. Finally, gauge displays the value graphically on an axis.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘number’, ‘delta’, ‘gauge’] joined with ‘+’ characters (e.g. ‘number+delta’)

Returns

Return type

Any

property name

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

The ‘number’ property is an instance of Number that may be specified as:

• An instance of plotly.graph_objects.indicator.Number

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

Returns

Return type

plotly.graph_objects.indicator.Number

property stream

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

• An instance of plotly.graph_objects.indicator.Stream

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

Returns

Return type

plotly.graph_objects.indicator.Stream

property title

The ‘title’ property is an instance of Title that may be specified as:

• An instance of plotly.graph_objects.indicator.Title

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

Returns

Return type

plotly.graph_objects.indicator.Title

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 value

Sets the number to be displayed.

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

• An int or float

Returns

Return type

int|float

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.Isosurface(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 caps

The ‘caps’ property is an instance of Caps that may be specified as:

• An instance of plotly.graph_objects.isosurface.Caps

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

Returns

Return type

plotly.graph_objects.isosurface.Caps

property cauto

Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

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

Returns

Return type

bool

property cmax

Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

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

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.isosurface.ColorBar

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

Returns

Return type

plotly.graph_objects.isosurface.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property contour

The ‘contour’ property is an instance of Contour that may be specified as:

• An instance of plotly.graph_objects.isosurface.Contour

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

Returns

Return type

plotly.graph_objects.isosurface.Contour

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 flatshading

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

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

Returns

Return type

bool

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.isosurface.Hoverlabel

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

Returns

Return type

plotly.graph_objects.isosurface.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 isomax

Sets the maximum boundary for iso-surface plot.

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

• An int or float

Returns

Return type

int|float

property isomin

Sets the minimum boundary for iso-surface plot.

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

• An int or float

Returns

Return type

int|float

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.isosurface.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.isosurface.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property lighting

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

• An instance of plotly.graph_objects.isosurface.Lighting

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

Returns

Return type

plotly.graph_objects.isosurface.Lighting

property lightposition

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

• An instance of plotly.graph_objects.isosurface.Lightposition

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

Returns

Return type

plotly.graph_objects.isosurface.Lightposition

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 appears 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 slices

The ‘slices’ property is an instance of Slices that may be specified as:

• An instance of plotly.graph_objects.isosurface.Slices

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

Returns

Return type

plotly.graph_objects.isosurface.Slices

property spaceframe

The ‘spaceframe’ property is an instance of Spaceframe that may be specified as:

• An instance of plotly.graph_objects.isosurface.Spaceframe

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

Returns

Return type

plotly.graph_objects.isosurface.Spaceframe

property stream

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

• An instance of plotly.graph_objects.isosurface.Stream

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

Returns

Return type

plotly.graph_objects.isosurface.Stream

property surface

The ‘surface’ property is an instance of Surface that may be specified as:

• An instance of plotly.graph_objects.isosurface.Surface

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

Returns

Return type

plotly.graph_objects.isosurface.Surface

property text

Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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

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 value

Sets the 4th dimension (value) of the vertices.

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

Returns

Return type

numpy.ndarray

property valuehoverformat

Sets the hover text formatting rulefor value using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘valuehoverformat’ 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 valuesrc

Sets the source reference on Chart Studio Cloud for value.

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

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 x

Sets the X coordinates of the vertices on X axis.

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

Returns

Return type

numpy.ndarray

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 vertices on Y axis.

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 vertices on Z axis.

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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.Layout(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutType

property activeselection

The ‘activeselection’ property is an instance of Activeselection that may be specified as:

• An instance of plotly.graph_objects.layout.Activeselection

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

Returns

Return type

plotly.graph_objects.layout.Activeselection

property activeshape

The ‘activeshape’ property is an instance of Activeshape that may be specified as:

• An instance of plotly.graph_objects.layout.Activeshape

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

Returns

Return type

plotly.graph_objects.layout.Activeshape

property annotationdefaults

When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations

The ‘annotationdefaults’ property is an instance of Annotation that may be specified as:

• An instance of plotly.graph_objects.layout.Annotation

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

Returns

Return type

plotly.graph_objects.layout.Annotation

property annotations

The ‘annotations’ property is a tuple of instances of Annotation that may be specified as:

• A list or tuple of instances of plotly.graph_objects.layout.Annotation

• A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Annotation]

property autosize

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

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

Returns

Return type

bool

property autotypenumbers

Using “strict” a numeric string in trace data is not converted to a number. Using convert types a numeric string in trace data may be treated as a number during automatic axis type detection. This is the default value; however it could be overridden for individual axes.

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

• One of the following enumeration values:

  [‘convert types’, ‘strict’]

Returns

Return type

Any

property barcornerradius

Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).

The ‘barcornerradius’ property accepts values of any type

Returns

Return type

Any

property bargap

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

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

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

Returns

Return type

int|float

property bargroupgap

Sets the gap (in plot fraction) between bars of the same location coordinate.

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

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

Returns

Return type

int|float

property barmode

Determines how bars at the same location coordinate are displayed on the graph. With “stack”, the bars are stacked on top of one another With “relative”, the bars are stacked on top of one another, with negative values below the axis, positive values above With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

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

• One of the following enumeration values:

  [‘stack’, ‘group’, ‘overlay’, ‘relative’]

Returns

Return type

Any

property barnorm

Sets the normalization for bar traces on the graph. With “fraction”, the value of each bar is divided by the sum of all values at that location coordinate. “percent” is the same but multiplied by 100 to show percentages.

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

• One of the following enumeration values:

  [‘’, ‘fraction’, ‘percent’]

Returns

Return type

Any

property boxgap

Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property boxgroupgap

Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property boxmode

Determines how boxes at the same location coordinate are displayed on the graph. If “group”, the boxes are plotted next to one another centered around the shared location. If “overlay”, the boxes are plotted over one another, you might need to set “opacity” to see them multiple boxes. Has no effect on traces that have “width” set.

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

• One of the following enumeration values:

  [‘group’, ‘overlay’]

Returns

Return type

Any

property calendar

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

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

• One of the following enumeration values:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property clickmode

Determines the mode of single click interactions. “event” is the default value and emits the plotly_click event. In addition this mode emits the plotly_selected event in drag modes “lasso” and “select”, but with no event data attached (kept for compatibility reasons). The “select” flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. “select” with hovermode: “x” can be confusing, consider explicitly setting hovermode: “closest” when using this feature. Selection events are sent accordingly as long as “event” flag is set as well. When the “event” flag is missing, plotly_click and plotly_selected events are not fired.

The ‘clickmode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘event’, ‘select’] joined with ‘+’ characters (e.g. ‘event+select’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property coloraxis

The ‘coloraxis’ property is an instance of Coloraxis that may be specified as:

• An instance of plotly.graph_objects.layout.Coloraxis

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

Returns

Return type

plotly.graph_objects.layout.Coloraxis

property colorscale

The ‘colorscale’ property is an instance of Colorscale that may be specified as:

• An instance of plotly.graph_objects.layout.Colorscale

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

Returns

Return type

plotly.graph_objects.layout.Colorscale

property colorway

Sets the default trace colors.

The ‘colorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property computed

Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in “full- json” mode.

The ‘computed’ property accepts values of any type

Returns

Return type

Any

property datarevision

If provided, a changed value tells Plotly.react that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, Plotly.react assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

The ‘datarevision’ property accepts values of any type

Returns

Return type

Any

property dragmode

Determines the mode of drag interactions. “select” and “lasso” apply only to scatter traces with markers or text. “orbit” and “turntable” apply only to 3D scenes.

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

• One of the following enumeration values:

  [‘zoom’, ‘pan’, ‘select’, ‘lasso’, ‘drawclosedpath’, ‘drawopenpath’, ‘drawline’, ‘drawrect’, ‘drawcircle’, ‘orbit’, ‘turntable’, False]

Returns

Return type

Any

property editrevision

true` configuration, other than trace names and axis titles. Defaults to layout.uirevision.

The ‘editrevision’ property accepts values of any type

Returns

Return type

Any

Type

Controls persistence of user-driven changes in `editable

property extendfunnelareacolors

If true, the funnelarea slice colors (whether given by funnelareacolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendiciclecolors

If true, the icicle slice colors (whether given by iciclecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendpiecolors

If true, the pie slice colors (whether given by piecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendsunburstcolors

If true, the sunburst slice colors (whether given by sunburstcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendtreemapcolors

If true, the treemap slice colors (whether given by treemapcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property font

Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

The ‘font’ property is an instance of Font that may be specified as:

• An instance of plotly.graph_objects.layout.Font

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

Returns

Return type

plotly.graph_objects.layout.Font

property funnelareacolorway

Sets the default funnelarea slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendfunnelareacolors.

The ‘funnelareacolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property funnelgap

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

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

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

Returns

Return type

int|float

property funnelgroupgap

Sets the gap (in plot fraction) between bars of the same location coordinate.

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

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

Returns

Return type

int|float

property funnelmode

Determines how bars at the same location coordinate are displayed on the graph. With “stack”, the bars are stacked on top of one another With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

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

• One of the following enumeration values:

  [‘stack’, ‘group’, ‘overlay’]

Returns

Return type

Any

property geo

The ‘geo’ property is an instance of Geo that may be specified as:

• An instance of plotly.graph_objects.layout.Geo

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

Returns

Return type

plotly.graph_objects.layout.Geo

property grid

The ‘grid’ property is an instance of Grid that may be specified as:

• An instance of plotly.graph_objects.layout.Grid

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

Returns

Return type

plotly.graph_objects.layout.Grid

property height

Sets the plot’s height (in px).

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

• An int or float in the interval [10, inf]

Returns

Return type

int|float

property hiddenlabels

hiddenlabels is the funnelarea & pie chart analog of visible:’legendonly’ but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

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

Returns

Return type

numpy.ndarray

property hiddenlabelssrc

Sets the source reference on Chart Studio Cloud for hiddenlabels.

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

Returns

Return type

str

property hidesources

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart- studio.plotly.com or on-premise).

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

Returns

Return type

bool

property hoverdistance

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point- like objects in case of conflict.

The ‘hoverdistance’ 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 hoverlabel

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

• An instance of plotly.graph_objects.layout.Hoverlabel

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

Returns

Return type

plotly.graph_objects.layout.Hoverlabel

property hovermode

Determines the mode of hover interactions. If “closest”, a single hoverlabel will appear for the “closest” point within the hoverdistance. If “x” (or “y”), multiple hoverlabels will appear for multiple points at the “closest” x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If x unified (or y unified), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.

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

• One of the following enumeration values:

  [‘x’, ‘y’, ‘closest’, False, ‘x unified’, ‘y unified’]

Returns

Return type

Any

property hoversubplots

Determines expansion of hover effects to other subplots If “single” just the axis pair of the primary point is included without overlaying subplots. If “overlaying” all subplots using the main axis and occupying the same space are included. If “axis”, also include stacked subplots using the same axis when hovermode is set to “x”, x unified, “y” or y unified.

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

• One of the following enumeration values:

  [‘single’, ‘overlaying’, ‘axis’]

Returns

Return type

Any

property iciclecolorway

Sets the default icicle slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendiciclecolors.

The ‘iciclecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property imagedefaults

When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images

The ‘imagedefaults’ property is an instance of Image that may be specified as:

• An instance of plotly.graph_objects.layout.Image

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

Returns

Return type

plotly.graph_objects.layout.Image

property images

The ‘images’ property is a tuple of instances of Image that may be specified as:

• A list or tuple of instances of plotly.graph_objects.layout.Image

• A list or tuple of dicts of string/value properties that will be passed to the Image constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Image]

property legend

The ‘legend’ property is an instance of Legend that may be specified as:

• An instance of plotly.graph_objects.layout.Legend

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

Returns

Return type

plotly.graph_objects.layout.Legend

property map

The ‘map’ property is an instance of Map that may be specified as:

• An instance of plotly.graph_objects.layout.Map

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

Returns

Return type

plotly.graph_objects.layout.Map

property mapbox

The ‘mapbox’ property is an instance of Mapbox that may be specified as:

• An instance of plotly.graph_objects.layout.Mapbox

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

Returns

Return type

plotly.graph_objects.layout.Mapbox

property margin

The ‘margin’ property is an instance of Margin that may be specified as:

• An instance of plotly.graph_objects.layout.Margin

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

Returns

Return type

plotly.graph_objects.layout.Margin

property meta

Assigns extra meta information that can be used in various text attributes. Attributes such as the graph, axis and colorbar title.text, annotation text trace.name in legend items, rangeselector, updatemenus and sliders label text all support meta. One can access meta fields using template strings: %{meta[i]} where i is the index of the meta item in question. meta can also be an object for example {key: value} which can be accessed %{meta[key]}.

The ‘meta’ property accepts values of any type

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 minreducedheight

Minimum height of the plot with margin.automargin applied (in px)

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

• An int or float in the interval [2, inf]

Returns

Return type

int|float

property minreducedwidth

Minimum width of the plot with margin.automargin applied (in px)

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

• An int or float in the interval [2, inf]

Returns

Return type

int|float

property modebar

The ‘modebar’ property is an instance of Modebar that may be specified as:

• An instance of plotly.graph_objects.layout.Modebar

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

Returns

Return type

plotly.graph_objects.layout.Modebar

property newselection

The ‘newselection’ property is an instance of Newselection that may be specified as:

• An instance of plotly.graph_objects.layout.Newselection

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

Returns

Return type

plotly.graph_objects.layout.Newselection

property newshape

The ‘newshape’ property is an instance of Newshape that may be specified as:

• An instance of plotly.graph_objects.layout.Newshape

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

Returns

Return type

plotly.graph_objects.layout.Newshape

property paper_bgcolor

Sets the background color of the paper where the graph is drawn.

The ‘paper_bgcolor’ 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: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property piecolorway

Sets the default pie slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendpiecolors.

The ‘piecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property plot_bgcolor

Sets the background color of the plotting area in-between x and y axes.

The ‘plot_bgcolor’ 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: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property polar

The ‘polar’ property is an instance of Polar that may be specified as:

• An instance of plotly.graph_objects.layout.Polar

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

Returns

Return type

plotly.graph_objects.layout.Polar

re = <module 're' from '/home/circleci/.pyenv/versions/3.9.25/lib/python3.9/re.py'>

property scattergap

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.

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

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

Returns

Return type

int|float

property scattermode

Determines how scatter points at the same location coordinate are displayed on the graph. With “group”, the scatter points are plotted next to one another centered around the shared location. With “overlay”, the scatter points are plotted over one another, you might need to reduce “opacity” to see multiple scatter points.

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

• One of the following enumeration values:

  [‘group’, ‘overlay’]

Returns

Return type

Any

property scene

The ‘scene’ property is an instance of Scene that may be specified as:

• An instance of plotly.graph_objects.layout.Scene

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

Returns

Return type

plotly.graph_objects.layout.Scene

property selectdirection

When dragmode is set to “select”, this limits the selection of the drag to horizontal, vertical or diagonal. “h” only allows horizontal selection, “v” only vertical, “d” only diagonal and “any” sets no limit.

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

• One of the following enumeration values:

  [‘h’, ‘v’, ‘d’, ‘any’]

Returns

Return type

Any

property selectiondefaults

When used in a template (as layout.template.layout.selectiondefaults), sets the default property values to use for elements of layout.selections

The ‘selectiondefaults’ property is an instance of Selection that may be specified as:

• An instance of plotly.graph_objects.layout.Selection

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

Returns

Return type

plotly.graph_objects.layout.Selection

property selectionrevision

Controls persistence of user-driven changes in selected points from all traces.

The ‘selectionrevision’ property accepts values of any type

Returns

Return type

Any

property selections

The ‘selections’ property is a tuple of instances of Selection that may be specified as:

• A list or tuple of instances of plotly.graph_objects.layout.Selection

• A list or tuple of dicts of string/value properties that will be passed to the Selection constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Selection]

property separators

Sets the decimal and thousand separators. For example, *. * puts a ‘.’ before decimals and a space between thousands. In English locales, dflt is “.,” but other locales may alter this default.

The ‘separators’ 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 shapedefaults

When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes

The ‘shapedefaults’ property is an instance of Shape that may be specified as:

• An instance of plotly.graph_objects.layout.Shape

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

Returns

Return type

plotly.graph_objects.layout.Shape

property shapes

The ‘shapes’ property is a tuple of instances of Shape that may be specified as:

• A list or tuple of instances of plotly.graph_objects.layout.Shape

• A list or tuple of dicts of string/value properties that will be passed to the Shape constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Shape]

property showlegend

Determines whether or not a legend is drawn. Default is true if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with showlegend: true.

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

Returns

Return type

bool

property sliderdefaults

When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders

The ‘sliderdefaults’ property is an instance of Slider that may be specified as:

• An instance of plotly.graph_objects.layout.Slider

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

Returns

Return type

plotly.graph_objects.layout.Slider

property sliders

The ‘sliders’ property is a tuple of instances of Slider that may be specified as:

• A list or tuple of instances of plotly.graph_objects.layout.Slider

• A list or tuple of dicts of string/value properties that will be passed to the Slider constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Slider]

property smith

The ‘smith’ property is an instance of Smith that may be specified as:

• An instance of plotly.graph_objects.layout.Smith

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

Returns

Return type

plotly.graph_objects.layout.Smith

property spikedistance

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area- like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

The ‘spikedistance’ 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 sunburstcolorway

Sets the default sunburst slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendsunburstcolors.

The ‘sunburstcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property template

Default attributes to be applied to the plot. This should be a dict with format: {'layout': layoutTemplate, 'data': {trace_type: [traceTemplate, ...], ...}} where layoutTemplate is a dict matching the structure of figure.layout and traceTemplate is a dict matching the structure of the trace with type trace_type (e.g. ‘scatter’). Alternatively, this may be specified as an instance of plotly.graph_objects.layout.Template. Trace templates are applied cyclically to traces of each type. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so this can be used to add a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

The ‘template’ property is an instance of Template that may be specified as:

• An instance of plotly.graph_objects.layout.Template

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

• The name of a registered template where current registered templates are stored in the plotly.io.templates configuration object. The names of all registered templates can be retrieved with:

  >>> import plotly.io as pio
  >>> list(pio.templates)  
  ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]
  

• A string containing multiple registered template names, joined on ‘+’ characters (e.g. ‘template1+template2’). In this case the resulting template is computed by merging together the collection of registered templates

Returns

Return type

plotly.graph_objects.layout.Template

property ternary

The ‘ternary’ property is an instance of Ternary that may be specified as:

• An instance of plotly.graph_objects.layout.Ternary

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

Returns

Return type

plotly.graph_objects.layout.Ternary

property title

The ‘title’ property is an instance of Title that may be specified as:

• An instance of plotly.graph_objects.layout.Title

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

Returns

Return type

plotly.graph_objects.layout.Title

property transition

Sets transition options used during Plotly.react updates.

The ‘transition’ property is an instance of Transition that may be specified as:

• An instance of plotly.graph_objects.layout.Transition

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

Returns

Return type

plotly.graph_objects.layout.Transition

property treemapcolorway

Sets the default treemap slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendtreemapcolors.

The ‘treemapcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property uirevision

Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions. If uirevision is omitted, or if it is given and it changed from the previous Plotly.react call, the exact new figure is used. If uirevision is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. layout.uirevision attribute serves as the default for uirevision attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set xaxis.uirevision=*time* and yaxis.uirevision=*cost*. Then if only the y data is changed, you can update yaxis.uirevision=*quantity* and the y axis range will reset but the x axis range will retain any user- driven zoom.

The ‘uirevision’ property accepts values of any type

Returns

Return type

Any

property uniformtext

The ‘uniformtext’ property is an instance of Uniformtext that may be specified as:

• An instance of plotly.graph_objects.layout.Uniformtext

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

Returns

Return type

plotly.graph_objects.layout.Uniformtext

property updatemenudefaults

When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus

The ‘updatemenudefaults’ property is an instance of Updatemenu that may be specified as:

• An instance of plotly.graph_objects.layout.Updatemenu

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

Returns

Return type

plotly.graph_objects.layout.Updatemenu

property updatemenus

The ‘updatemenus’ property is a tuple of instances of Updatemenu that may be specified as:

• A list or tuple of instances of plotly.graph_objects.layout.Updatemenu

• A list or tuple of dicts of string/value properties that will be passed to the Updatemenu constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Updatemenu]

property violingap

Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property violingroupgap

Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property violinmode

Determines how violins at the same location coordinate are displayed on the graph. If “group”, the violins are plotted next to one another centered around the shared location. If “overlay”, the violins are plotted over one another, you might need to set “opacity” to see them multiple violins. Has no effect on traces that have “width” set.

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

• One of the following enumeration values:

  [‘group’, ‘overlay’]

Returns

Return type

Any

property waterfallgap

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

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

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

Returns

Return type

int|float

property waterfallgroupgap

Sets the gap (in plot fraction) between bars of the same location coordinate.

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

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

Returns

Return type

int|float

property waterfallmode

Determines how bars at the same location coordinate are displayed on the graph. With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

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

• One of the following enumeration values:

  [‘group’, ‘overlay’]

Returns

Return type

Any

property width

Sets the plot’s width (in px).

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

• An int or float in the interval [10, inf]

Returns

Return type

int|float

property xaxis

The ‘xaxis’ property is an instance of XAxis that may be specified as:

• An instance of plotly.graph_objects.layout.XAxis

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

Returns

Return type

plotly.graph_objects.layout.XAxis

property yaxis

The ‘yaxis’ property is an instance of YAxis that may be specified as:

• An instance of plotly.graph_objects.layout.YAxis

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

Returns

Return type

plotly.graph_objects.layout.YAxis

class plotly.graph_objects.Legend(*args, **kwargs)

Bases: dict

plotly.graph_objects.Legend is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.Legend

class plotly.graph_objects.Line(*args, **kwargs)

Bases: dict

plotly.graph_objects.Line is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.scatter.Line

• plotly.graph_objects.layout.shape.Line

• etc.

class plotly.graph_objects.Margin(*args, **kwargs)

Bases: dict

plotly.graph_objects.Margin is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.Margin

class plotly.graph_objects.Marker(*args, **kwargs)

Bases: dict

plotly.graph_objects.Marker is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.scatter.Marker

• plotly.graph_objects.histogram.selected.Marker

• etc.

class plotly.graph_objects.Mesh3d(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property alphahull

Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the x, y and z arrays, if the i, j, k arrays are not supplied. For general use of mesh3d it is preferred that i, j, k are supplied. If “-1”, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to delaunayaxis. In case the delaunayaxis intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of delaunayaxis. If “>0”, the alpha-shape algorithm is used. In this case, the positive alphahull value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the x, y and z point set into a convex hull.

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

• An int or float

Returns

Return type

int|float

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 cauto

Determines whether or not the color domain is computed with respect to the input data (here intensity) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

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

Returns

Return type

bool

property cmax

Sets the upper bound of the color domain. Value should have the same units as intensity and if set, cmin must be set as well.

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 intensity. 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 intensity 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 color

Sets the color of the whole mesh

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: see https://plotly.com/python/css-colors/ for a list

• A number that will be interpreted as a color according to mesh3d.colorscale

Returns

Return type

str

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.mesh3d.ColorBar

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

Returns

Return type

plotly.graph_objects.mesh3d.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property contour

The ‘contour’ property is an instance of Contour that may be specified as:

• An instance of plotly.graph_objects.mesh3d.Contour

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

Returns

Return type

plotly.graph_objects.mesh3d.Contour

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 delaunayaxis

Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if i, j, k are not provided and alphahull is set to indicate Delaunay triangulation.

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

• One of the following enumeration values:

  [‘x’, ‘y’, ‘z’]

Returns

Return type

Any

property facecolor

Sets the color of each face Overrides “color” and “vertexcolor”.

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

Returns

Return type

numpy.ndarray

property facecolorsrc

Sets the source reference on Chart Studio Cloud for facecolor.

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

Returns

Return type

str

property flatshading

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

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

Returns

Return type

bool

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.mesh3d.Hoverlabel

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

Returns

Return type

plotly.graph_objects.mesh3d.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 i

A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “first” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where i[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in i represents a point in space, which is the first vertex of a triangle.

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

Returns

Return type

numpy.ndarray

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 intensity

Sets the intensity values for vertices or cells as defined by intensitymode. It can be used for plotting fields on meshes.

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

Returns

Return type

numpy.ndarray

property intensitymode

Determines the source of intensity values.

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

• One of the following enumeration values:

  [‘vertex’, ‘cell’]

Returns

Return type

Any

property intensitysrc

Sets the source reference on Chart Studio Cloud for intensity.

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

Returns

Return type

str

property isrc

Sets the source reference on Chart Studio Cloud for i.

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

Returns

Return type

str

property j

A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “second” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where j[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in j represents a point in space, which is the second vertex of a triangle.

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

Returns

Return type

numpy.ndarray

property jsrc

Sets the source reference on Chart Studio Cloud for j.

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

Returns

Return type

str

property k

A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “third” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where k[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in k represents a point in space, which is the third vertex of a triangle.

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

Returns

Return type

numpy.ndarray

property ksrc

Sets the source reference on Chart Studio Cloud for k.

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

Returns

Return type

str

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.mesh3d.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.mesh3d.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property lighting

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

• An instance of plotly.graph_objects.mesh3d.Lighting

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

Returns

Return type

plotly.graph_objects.mesh3d.Lighting

property lightposition

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

• An instance of plotly.graph_objects.mesh3d.Lightposition

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

Returns

Return type

plotly.graph_objects.mesh3d.Lightposition

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 appears 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 stream

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

• An instance of plotly.graph_objects.mesh3d.Stream

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

Returns

Return type

plotly.graph_objects.mesh3d.Stream

property text

Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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

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 vertexcolor

Sets the color of each vertex Overrides “color”. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.

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

Returns

Return type

numpy.ndarray

property vertexcolorsrc

Sets the source reference on Chart Studio Cloud for vertexcolor.

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

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 x

Sets the X coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

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

Returns

Return type

numpy.ndarray

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

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

Returns

Return type

numpy.ndarray

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

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

Returns

Return type

numpy.ndarray

property zcalendar

Sets the calendar system to use with z date data.

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

• One of the following enumeration values:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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.Ohlc(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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.ohlc.Decreasing

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

Returns

Return type

plotly.graph_objects.ohlc.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.ohlc.Hoverlabel

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

Returns

Return type

plotly.graph_objects.ohlc.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables open, high, low and close. 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 increasing

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

• An instance of plotly.graph_objects.ohlc.Increasing

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

Returns

Return type

plotly.graph_objects.ohlc.Increasing

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

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

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.ohlc.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.ohlc.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

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

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property line

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

• An instance of plotly.graph_objects.ohlc.Line

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

Returns

Return type

plotly.graph_objects.ohlc.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

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 appears 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

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.ohlc.Stream

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

Returns

Return type

plotly.graph_objects.ohlc.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 tickwidth

Sets the width of the open/close tick marks relative to the “x” minimal interval.

The ‘tickwidth’ 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 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

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

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

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

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

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

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.Parcats(arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property arrangement

Sets the drag interaction mode for categories and dimensions. If perpendicular, the categories can only move along a line perpendicular to the paths. If freeform, the categories can freely move on the plane. If fixed, the categories and dimensions are stationary.

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

• One of the following enumeration values:

  [‘perpendicular’, ‘freeform’, ‘fixed’]

Returns

Return type

Any

property bundlecolors

Sort paths so that like colors are bundled together within each category.

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

Returns

Return type

bool

property counts

The number of observations represented by each state. Defaults to 1 so that each state represents one observation

The ‘counts’ 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 countssrc

Sets the source reference on Chart Studio Cloud for counts.

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

Returns

Return type

str

property dimensiondefaults

When used in a template (as layout.template.data.parcats.dimensiondefaults), sets the default property values to use for elements of parcats.dimensions

The ‘dimensiondefaults’ property is an instance of Dimension that may be specified as:

• An instance of plotly.graph_objects.parcats.Dimension

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

Returns

Return type

plotly.graph_objects.parcats.Dimension

property dimensions

The dimensions (variables) of the parallel categories diagram.

The ‘dimensions’ property is a tuple of instances of Dimension that may be specified as:

• A list or tuple of instances of plotly.graph_objects.parcats.Dimension

• A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor

Returns

Return type

tuple[plotly.graph_objects.parcats.Dimension]

property domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.parcats.Domain

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

Returns

Return type

plotly.graph_objects.parcats.Domain

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 [‘count’, ‘probability’] joined with ‘+’ characters (e.g. ‘count+probability’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

Returns

Return type

Any

property hoveron

Sets the hover interaction mode for the parcats diagram. If category, hover interaction take place per category. If color, hover interactions take place per color per category. If dimension, hover interactions take place across all categories per dimension.

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

• One of the following enumeration values:

  [‘category’, ‘color’, ‘dimension’]

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables count, probability, category, categorycount, colorcount and bandcolorcount. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

property labelfont

Sets the font for the dimension labels.

The ‘labelfont’ property is an instance of Labelfont that may be specified as:

• An instance of plotly.graph_objects.parcats.Labelfont

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

Returns

Return type

plotly.graph_objects.parcats.Labelfont

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.parcats.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.parcats.Legendgrouptitle

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

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

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

Returns

Return type

int|float

property line

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

• An instance of plotly.graph_objects.parcats.Line

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

Returns

Return type

plotly.graph_objects.parcats.Line

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 appears 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 sortpaths

Sets the path sorting algorithm. If forward, sort paths based on dimension categories from left to right. If backward, sort paths based on dimensions categories from right to left.

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

• One of the following enumeration values:

  [‘forward’, ‘backward’]

Returns

Return type

Any

property stream

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

• An instance of plotly.graph_objects.parcats.Stream

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

Returns

Return type

plotly.graph_objects.parcats.Stream

property tickfont

Sets the font for the category labels.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

• An instance of plotly.graph_objects.parcats.Tickfont

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

Returns

Return type

plotly.graph_objects.parcats.Tickfont

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.Parcoords(arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 dimensiondefaults

When used in a template (as layout.template.data.parcoords.dimensiondefaults), sets the default property values to use for elements of parcoords.dimensions

The ‘dimensiondefaults’ property is an instance of Dimension that may be specified as:

• An instance of plotly.graph_objects.parcoords.Dimension

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

Returns

Return type

plotly.graph_objects.parcoords.Dimension

property dimensions

The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.

The ‘dimensions’ property is a tuple of instances of Dimension that may be specified as:

• A list or tuple of instances of plotly.graph_objects.parcoords.Dimension

• A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor

Returns

Return type

tuple[plotly.graph_objects.parcoords.Dimension]

property domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.parcoords.Domain

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

Returns

Return type

plotly.graph_objects.parcoords.Domain

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 labelangle

Sets the angle of the labels with respect to the horizontal. For example, a tickangle of -90 draws the labels vertically. Tilted labels with “labelangle” may be positioned better inside margins when labelposition is set to “bottom”.

The ‘labelangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns

Return type

int|float

property labelfont

Sets the font for the dimension labels.

The ‘labelfont’ property is an instance of Labelfont that may be specified as:

• An instance of plotly.graph_objects.parcoords.Labelfont

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

Returns

Return type

plotly.graph_objects.parcoords.Labelfont

property labelside

Specifies the location of the label. “top” positions labels above, next to the title “bottom” positions labels below the graph Tilted labels with “labelangle” may be positioned better inside margins when labelposition is set to “bottom”.

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

• One of the following enumeration values:

  [‘top’, ‘bottom’]

Returns

Return type

Any

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.parcoords.Legendgrouptitle

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

Returns

Return type

plotly.graph_objects.parcoords.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.parcoords.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.parcoords.Line

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 appears 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 rangefont

Sets the font for the dimension range values.

The ‘rangefont’ property is an instance of Rangefont that may be specified as:

• An instance of plotly.graph_objects.parcoords.Rangefont

• A dict of string/value properties that will be passed to the Rangefont constructor

Returns

Return type

plotly.graph_objects.parcoords.Rangefont

property stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.parcoords.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.parcoords.Stream

property tickfont

Sets the font for the dimension tick values.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

• An instance of plotly.graph_objects.parcoords.Tickfont

• A dict of string/value properties that will be passed to the Tickfont constructor

Returns

Return type

plotly.graph_objects.parcoords.Tickfont

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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.parcoords.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.parcoords.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

class plotly.graph_objects.Pie(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property automargin

Determines whether outside text labels can push the margins.

The ‘automargin’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 direction

Specifies the direction at which succeeding sectors follow one another.

The ‘direction’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘clockwise’, ‘counterclockwise’]

Returns

Return type

Any

property dlabel

Sets the label step. See label0 for more info.

The ‘dlabel’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.pie.Domain

• A dict of string/value properties that will be passed to the Domain constructor

Returns

Return type

plotly.graph_objects.pie.Domain

property hole

Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

The ‘hole’ property is a number and may be specified as:

• An int or float in the interval [0, 1]

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 [‘label’, ‘text’, ‘value’, ‘percent’, ‘name’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.pie.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.pie.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

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 insidetextfont

Sets the font used for textinfo lying inside the sector.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

• An instance of plotly.graph_objects.pie.Insidetextfont

• A dict of string/value properties that will be passed to the Insidetextfont constructor

Returns

Return type

plotly.graph_objects.pie.Insidetextfont

property insidetextorientation

Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.

The ‘insidetextorientation’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘horizontal’, ‘radial’, ‘tangential’, ‘auto’]

Returns

Return type

Any

property label0

Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

The ‘label0’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property labels

Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property labelssrc

Sets the source reference on Chart Studio Cloud for labels.

The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.pie.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.pie.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.pie.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.pie.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 appears 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 outsidetextfont

Sets the font used for textinfo lying outside the sector.

The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:

• An instance of plotly.graph_objects.pie.Outsidetextfont

• A dict of string/value properties that will be passed to the Outsidetextfont constructor

Returns

Return type

plotly.graph_objects.pie.Outsidetextfont

property pull

Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

The ‘pull’ property is a number and may be specified as:

• An int or float in the interval [0, 1]

• A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property pullsrc

Sets the source reference on Chart Studio Cloud for pull.

The ‘pullsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property rotation

Instead of the first slice starting at 12 o’clock, rotate to some other angle.

The ‘rotation’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns

Return type

int|float

property scalegroup

If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

The ‘scalegroup’ 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 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 sort

Determines whether or not the sectors are reordered from largest to smallest.

The ‘sort’ property must be specified as a bool (either True, or False)

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.pie.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.pie.Stream

property text

Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property textfont

Sets the font used for textinfo.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.pie.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.pie.Textfont

property textinfo

Determines which trace information appear on the graph.

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘value’, ‘percent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property textposition

Specifies the location of the textinfo.

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 title

The ‘title’ property is an instance of Title that may be specified as:

• An instance of plotly.graph_objects.pie.Title

• A dict of string/value properties that will be passed to the Title constructor

Returns

Return type

plotly.graph_objects.pie.Title

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 values

Sets the values of the sectors. If omitted, we count occurrences of each label.

The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property valuessrc

Sets the source reference on Chart Studio Cloud for values.

The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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

class plotly.graph_objects.RadialAxis(*args, **kwargs)

Bases: dict

plotly.graph_objects.RadialAxis is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.RadialAxis

• plotly.graph_objects.layout.polar.RadialAxis

class plotly.graph_objects.Sankey(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property arrangement

If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad. If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

The ‘arrangement’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘snap’, ‘perpendicular’, ‘freeform’, ‘fixed’]

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 domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.sankey.Domain

• A dict of string/value properties that will be passed to the Domain constructor

Returns

Return type

plotly.graph_objects.sankey.Domain

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. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [] joined with ‘+’ characters (e.g. ‘’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

Returns

Return type

Any

property hoverlabel

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

• An instance of plotly.graph_objects.sankey.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.sankey.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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.sankey.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.sankey.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property link

The links of the Sankey plot.

The ‘link’ property is an instance of Link that may be specified as:

• An instance of plotly.graph_objects.sankey.Link

• A dict of string/value properties that will be passed to the Link constructor

Returns

Return type

plotly.graph_objects.sankey.Link

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 appears 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 node

The nodes of the Sankey plot.

The ‘node’ property is an instance of Node that may be specified as:

• An instance of plotly.graph_objects.sankey.Node

• A dict of string/value properties that will be passed to the Node constructor

Returns

Return type

plotly.graph_objects.sankey.Node

property orientation

Sets the orientation of the Sankey diagram.

The ‘orientation’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘v’, ‘h’]

Returns

Return type

Any

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 stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.sankey.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.sankey.Stream

property textfont

Sets the font for node labels

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.sankey.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.sankey.Textfont

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 valueformat

Sets the value formatting rule using d3 formatting mini- languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.

The ‘valueformat’ 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 valuesuffix

Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

The ‘valuesuffix’ 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 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.Scatter(arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 cliponaxis

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

The ‘cliponaxis’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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.scatter.ErrorX

• A dict of string/value properties that will be passed to the ErrorX constructor

Returns

Return type

plotly.graph_objects.scatter.ErrorX

property error_y

The ‘error_y’ property is an instance of ErrorY that may be specified as:

• An instance of plotly.graph_objects.scatter.ErrorY

• A dict of string/value properties that will be passed to the ErrorY constructor

Returns

Return type

plotly.graph_objects.scatter.ErrorY

property fill

Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill- linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘tozeroy’, ‘tozerox’, ‘tonexty’, ‘tonextx’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.

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: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property fillgradient

Sets a fill gradient. If not specified, the fillcolor is used instead.

The ‘fillgradient’ property is an instance of Fillgradient that may be specified as:

• An instance of plotly.graph_objects.scatter.Fillgradient

• A dict of string/value properties that will be passed to the Fillgradient constructor

Returns

Return type

plotly.graph_objects.scatter.Fillgradient

property fillpattern

Sets the pattern within the marker.

The ‘fillpattern’ property is an instance of Fillpattern that may be specified as:

• An instance of plotly.graph_objects.scatter.Fillpattern

• A dict of string/value properties that will be passed to the Fillpattern constructor

Returns

Return type

plotly.graph_objects.scatter.Fillpattern

property groupnorm

Only relevant when stackgroup is used, and only the first groupnorm found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the normalization for the sum of this stackgroup. With “fraction”, the value of each trace at each location is divided by the sum of all trace values at that location. “percent” is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.

The ‘groupnorm’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘’, ‘fraction’, ‘percent’]

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 [‘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.scatter.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scatter.Hoverlabel

property hoveron

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

The ‘hoveron’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scatter.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scatter.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scatter.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scatter.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scatter.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scatter.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 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

1. when scattermode is set to “group”. 2. when stackgroup is used, and only the first orientation found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the stacking direction. With “v” (“h”), the y (x) values of subsequent traces are added. Also affects the default value of fill.

The ‘orientation’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘v’, ‘h’]

Returns

Return type

Any

Type

Only relevant in the following cases

property selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scatter.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scatter.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 stackgaps

Only relevant when stackgroup is used, and only the first stackgaps found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Determines how we handle locations at which other traces in this group have data but this one does not. With infer zero we insert a zero at these locations. With “interpolate” we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

The ‘stackgaps’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘infer zero’, ‘interpolate’]

Returns

Return type

Any

property stackgroup

Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if orientation is “h”). If blank or omitted this trace will not be stacked. Stacking also turns fill on by default, using “tonexty” (“tonextx”) if orientation is “h” (“v”) and sets the default mode to “lines” irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

The ‘stackgroup’ 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 stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.scatter.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scatter.Stream

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scatter.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scatter.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scatter.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scatter.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 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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

The ‘xperiodalignment’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

The ‘yperiodalignment’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

The ‘zorder’ property is a integer and may be specified as:

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.Scatter3d(arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 error_x

The ‘error_x’ property is an instance of ErrorX that may be specified as:

• An instance of plotly.graph_objects.scatter3d.ErrorX

• A dict of string/value properties that will be passed to the ErrorX constructor

Returns

Return type

plotly.graph_objects.scatter3d.ErrorX

property error_y

The ‘error_y’ property is an instance of ErrorY that may be specified as:

• An instance of plotly.graph_objects.scatter3d.ErrorY

• A dict of string/value properties that will be passed to the ErrorY constructor

Returns

Return type

plotly.graph_objects.scatter3d.ErrorY

property error_z

The ‘error_z’ property is an instance of ErrorZ that may be specified as:

• An instance of plotly.graph_objects.scatter3d.ErrorZ

• A dict of string/value properties that will be passed to the ErrorZ constructor

Returns

Return type

plotly.graph_objects.scatter3d.ErrorZ

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.scatter3d.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scatter3d.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y,z) coordinates. To be seen, trace hoverinfo must contain a “text” flag.

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scatter3d.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scatter3d.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scatter3d.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scatter3d.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scatter3d.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scatter3d.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 projection

The ‘projection’ property is an instance of Projection that may be specified as:

• An instance of plotly.graph_objects.scatter3d.Projection

• A dict of string/value properties that will be passed to the Projection constructor

Returns

Return type

plotly.graph_objects.scatter3d.Projection

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 stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.scatter3d.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scatter3d.Stream

property surfaceaxis

If “-1”, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

The ‘surfaceaxis’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [-1, 0, 1, 2]

Returns

Return type

Any

property surfacecolor

Sets the surface fill color.

The ‘surfacecolor’ 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: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property text

Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y,z) coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scatter3d.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scatter3d.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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

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 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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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.

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 zcalendar

Sets the calendar system to use with z date data.

The ‘zcalendar’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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.Scattercarpet(arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property a

Sets the a-axis coordinates.

The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

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

Sets the b-axis 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 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 connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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 [‘a’, ‘b’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘a+b’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.scattercarpet.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scattercarpet.Hoverlabel

property hoveron

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

The ‘hoveron’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace hoverinfo must contain a “text” flag.

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scattercarpet.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scattercarpet.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scattercarpet.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scattercarpet.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scattercarpet.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scattercarpet.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scattercarpet.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scattercarpet.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.scattercarpet.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scattercarpet.Stream

property text

Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scattercarpet.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scattercarpet.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scattercarpet.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scattercarpet.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 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 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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

The ‘zorder’ property is a integer and may be specified as:

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.Scattergeo(arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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 when locations is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

The ‘geojson’ property accepts values of any type

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 [‘lon’, ‘lat’, ‘location’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘lon+lat’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.scattergeo.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scattergeo.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. To be seen, trace hoverinfo must contain a “text” flag.

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scattergeo.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scattergeo.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scattergeo.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scattergeo.Line

property locationmode

The library used by the country names locationmode option is changing in an upcoming version. Country names in existing plots may not work in the new version. 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. Coordinates correspond to the centroid of each location given. See locationmode for more info.

The ‘locations’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

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 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 marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scattergeo.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scattergeo.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scattergeo.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scattergeo.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.scattergeo.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scattergeo.Stream

property text

Sets text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (lon,lat) or locations coordinates. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scattergeo.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scattergeo.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon, location and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scattergeo.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scattergeo.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

class plotly.graph_objects.Scattergl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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.scattergl.ErrorX

• A dict of string/value properties that will be passed to the ErrorX constructor

Returns

Return type

plotly.graph_objects.scattergl.ErrorX

property error_y

The ‘error_y’ property is an instance of ErrorY that may be specified as:

• An instance of plotly.graph_objects.scattergl.ErrorY

• A dict of string/value properties that will be passed to the ErrorY constructor

Returns

Return type

plotly.graph_objects.scattergl.ErrorY

property fill

Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill- linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘tozeroy’, ‘tozerox’, ‘tonexty’, ‘tonextx’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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.scattergl.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scattergl.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scattergl.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scattergl.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scattergl.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scattergl.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scattergl.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scattergl.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 mode

Determines the drawing mode for this scatter trace.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scattergl.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scattergl.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.scattergl.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scattergl.Stream

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scattergl.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scattergl.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scattergl.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scattergl.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 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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

The ‘xperiodalignment’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

The ‘yperiodalignment’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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.Scattermap(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property below

Determines if this scattermap trace’s layers are to be inserted before the layer with the specified ID. By default, scattermap layers are inserted above all the base layers. To place the scattermap layers above every other layer, set below to “’’”.

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 cluster

The ‘cluster’ property is an instance of Cluster that may be specified as:

• An instance of plotly.graph_objects.scattermap.Cluster

• A dict of string/value properties that will be passed to the Cluster constructor

Returns

Return type

plotly.graph_objects.scattermap.Cluster

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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’, ‘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.scattermap.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scattermap.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scattermap.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scattermap.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scattermap.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scattermap.Line

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 marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scattermap.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scattermap.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scattermap.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scattermap.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.scattermap.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scattermap.Stream

property subplot

Sets a reference between this trace’s data coordinates and a map subplot. If “map” (the default value), the data refer to layout.map. If “map2”, the data refer to layout.map2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘map’, that may be specified as the string ‘map’ optionally followed by an integer >= 1 (e.g. ‘map’, ‘map1’, ‘map2’, ‘map3’, etc.)

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 textfont

Sets the icon text font (color=map.layer.paint.text-color, size=map.layer.layout.text-size). Has an effect only when type is set to “symbol”.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scattermap.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scattermap.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

Returns

Return type

Any

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scattermap.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scattermap.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

class plotly.graph_objects.Scattermapbox(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property below

Determines if this scattermapbox trace’s layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set below to “’’”.

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 cluster

The ‘cluster’ property is an instance of Cluster that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Cluster

• A dict of string/value properties that will be passed to the Cluster constructor

Returns

Return type

plotly.graph_objects.scattermapbox.Cluster

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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’, ‘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.scattermapbox.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scattermapbox.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scattermapbox.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scattermapbox.Line

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 marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scattermapbox.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scattermapbox.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.scattermapbox.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scattermapbox.Stream

property subplot

mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace’s data coordinates and a mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘mapbox’, that may be specified as the string ‘mapbox’ optionally followed by an integer >= 1 (e.g. ‘mapbox’, ‘mapbox1’, ‘mapbox2’, ‘mapbox3’, etc.)

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 textfont

Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when type is set to “symbol”.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scattermapbox.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

Returns

Return type

Any

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scattermapbox.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scattermapbox.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

class plotly.graph_objects.Scatterpolar(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property cliponaxis

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

The ‘cliponaxis’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterpolar has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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 [‘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.scatterpolar.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scatterpolar.Hoverlabel

property hoveron

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

The ‘hoveron’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scatterpolar.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scatterpolar.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scatterpolar.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scatterpolar.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scatterpolar.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scatterpolar.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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

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.scatterpolar.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scatterpolar.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.scatterpolar.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scatterpolar.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 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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scatterpolar.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scatterpolar.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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

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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scatterpolar.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scatterpolar.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

class plotly.graph_objects.Scatterpolargl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill- linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘tozeroy’, ‘tozerox’, ‘tonexty’, ‘tonextx’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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 [‘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.scatterpolargl.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scatterpolargl.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scatterpolargl.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scatterpolargl.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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

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.scatterpolargl.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.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.scatterpolargl.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.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 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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scatterpolargl.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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

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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scatterpolargl.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scatterpolargl.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

class plotly.graph_objects.Scattersmith(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property cliponaxis

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

The ‘cliponaxis’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. scattersmith has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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 [‘real’, ‘imag’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘real+imag’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.scattersmith.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scattersmith.Hoverlabel

property hoveron

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

The ‘hoveron’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 imag

Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

The ‘imag’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property imagsrc

Sets the source reference on Chart Studio Cloud for imag.

The ‘imagsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scattersmith.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scattersmith.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scattersmith.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scattersmith.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scattersmith.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scattersmith.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 real

Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

The ‘real’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property realsrc

Sets the source reference on Chart Studio Cloud for real.

The ‘realsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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.scattersmith.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scattersmith.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.scattersmith.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scattersmith.Stream

property subplot

Sets a reference between this trace’s data coordinates and a smith subplot. If “smith” (the default value), the data refer to layout.smith. If “smith2”, the data refer to layout.smith2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘smith’, that may be specified as the string ‘smith’ optionally followed by an integer >= 1 (e.g. ‘smith’, ‘smith1’, ‘smith2’, ‘smith3’, etc.)

Returns

Return type

str

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scattersmith.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scattersmith.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables real, imag and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scattersmith.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scattersmith.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

class plotly.graph_objects.Scatterternary(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property a

Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

The ‘a’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

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

Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

The ‘b’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

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 c

Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

The ‘c’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property cliponaxis

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

The ‘cliponaxis’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property csrc

Sets the source reference on Chart Studio Cloud for c.

The ‘csrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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 fill

Sets the area to fill with a solid color. Use with fillcolor if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.

The ‘fill’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘none’, ‘toself’, ‘tonext’]

Returns

Return type

Any

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: see https://plotly.com/python/css-colors/ for a list

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 [‘a’, ‘b’, ‘c’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘a+b’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.scatterternary.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.scatterternary.Hoverlabel

property hoveron

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

The ‘hoveron’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘points’, ‘fills’] joined with ‘+’ characters (e.g. ‘points+fills’)

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace hoverinfo must contain a “text” flag.

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.scatterternary.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.scatterternary.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.scatterternary.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.scatterternary.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.scatterternary.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.scatterternary.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 mode

Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

The ‘mode’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘lines’, ‘markers’, ‘text’] joined with ‘+’ characters (e.g. ‘lines+markers’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property name

Sets the trace name. The trace name appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.scatterternary.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.scatterternary.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.scatterternary.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.scatterternary.Stream

property subplot

Sets a reference between this trace’s data coordinates and a ternary subplot. If “ternary” (the default value), the data refer to layout.ternary. If “ternary2”, the data refer to layout.ternary2, and so on.

The ‘subplot’ property is an identifier of a particular subplot, of type ‘ternary’, that may be specified as the string ‘ternary’ optionally followed by an integer >= 1 (e.g. ‘ternary’, ‘ternary1’, ‘ternary2’, ‘ternary3’, etc.)

Returns

Return type

str

property sum

The number each triplet should sum to, if only two of a, b, and c are provided. This overrides ternary<i>.sum to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sum

The ‘sum’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property text

Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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 textfont

Sets the text font.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.scatterternary.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.scatterternary.Textfont

property textposition

Sets the positions of the text elements with respects to the (x,y) coordinates.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

• A tuple, list, or one-dimensional numpy array of the above

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b, c and text.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.scatterternary.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.scatterternary.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

class plotly.graph_objects.Scene(*args, **kwargs)

Bases: dict

plotly.graph_objects.Scene is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.Scene

class plotly.graph_objects.Splom(arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 diagonal

The ‘diagonal’ property is an instance of Diagonal that may be specified as:

• An instance of plotly.graph_objects.splom.Diagonal

• A dict of string/value properties that will be passed to the Diagonal constructor

Returns

Return type

plotly.graph_objects.splom.Diagonal

property dimensiondefaults

When used in a template (as layout.template.data.splom.dimensiondefaults), sets the default property values to use for elements of splom.dimensions

The ‘dimensiondefaults’ property is an instance of Dimension that may be specified as:

• An instance of plotly.graph_objects.splom.Dimension

• A dict of string/value properties that will be passed to the Dimension constructor

Returns

Return type

plotly.graph_objects.splom.Dimension

property dimensions

The ‘dimensions’ property is a tuple of instances of Dimension that may be specified as:

• A list or tuple of instances of plotly.graph_objects.splom.Dimension

• A list or tuple of dicts of string/value properties that will be passed to the Dimension constructor

Returns

Return type

tuple[plotly.graph_objects.splom.Dimension]

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.splom.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.splom.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.splom.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.splom.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.splom.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.splom.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 appears 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 selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.splom.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.splom.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 showlowerhalf

Determines whether or not subplots on the lower half from the diagonal are displayed.

The ‘showlowerhalf’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property showupperhalf

Determines whether or not subplots on the upper half from the diagonal are displayed.

The ‘showupperhalf’ property must be specified as a bool (either True, or False)

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.splom.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.splom.Stream

property text

Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates.

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

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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.splom.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.splom.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 xaxes

Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

The ‘xaxes’ property is an info array that may be specified as: * a list of elements where:

The ‘xaxes[i]’ property is an identifier of a particular

subplot, of type ‘x’, that may be specified as the string ‘x’ optionally followed by an integer >= 1 (e.g. ‘x’, ‘x1’, ‘x2’, ‘x3’, etc.)

Returns

Return type

list

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 yaxes

Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

The ‘yaxes’ property is an info array that may be specified as: * a list of elements where:

The ‘yaxes[i]’ property is an identifier of a particular

subplot, of type ‘y’, that may be specified as the string ‘y’ optionally followed by an integer >= 1 (e.g. ‘y’, ‘y1’, ‘y2’, ‘y3’, etc.)

Returns

Return type

list

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ property is a string and must be specified as:

• A string

• A number that will be converted to a string

Returns

Return type

str

class plotly.graph_objects.Stream(*args, **kwargs)

Bases: dict

plotly.graph_objects.Stream is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.scatter.Stream

• plotly.graph_objects.area.Stream

class plotly.graph_objects.Streamtube(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 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

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.streamtube.ColorBar

• A dict of string/value properties that will be passed to the ColorBar constructor

Returns

Return type

plotly.graph_objects.streamtube.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

The ‘colorscale’ property is a colorscale and may be specified as:

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property 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’, ‘divergence’, ‘text’, ‘name’] joined with ‘+’ characters (e.g. ‘x+y’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.streamtube.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.streamtube.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables tubex, tubey, tubez, tubeu, tubev, tubew, norm and divergence. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.streamtube.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.streamtube.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property lighting

The ‘lighting’ property is an instance of Lighting that may be specified as:

• An instance of plotly.graph_objects.streamtube.Lighting

• A dict of string/value properties that will be passed to the Lighting constructor

Returns

Return type

plotly.graph_objects.streamtube.Lighting

property lightposition

The ‘lightposition’ property is an instance of Lightposition that may be specified as:

• An instance of plotly.graph_objects.streamtube.Lightposition

• A dict of string/value properties that will be passed to the Lightposition constructor

Returns

Return type

plotly.graph_objects.streamtube.Lightposition

property maxdisplayed

The maximum number of displayed segments in a streamtube.

The ‘maxdisplayed’ property is a integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

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 appears 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 sizeref

The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.

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 starts

The ‘starts’ property is an instance of Starts that may be specified as:

• An instance of plotly.graph_objects.streamtube.Starts

• A dict of string/value properties that will be passed to the Starts constructor

Returns

Return type

plotly.graph_objects.streamtube.Starts

property stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.streamtube.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.streamtube.Stream

property text

Sets a text element associated with this trace. If trace hoverinfo contains a “text” flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array text values.

The ‘text’ 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 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 uhoverformat

Sets the hover text formatting rulefor u using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘uhoverformat’ 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 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 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 vhoverformat

Sets the hover text formatting rulefor v using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘vhoverformat’ 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 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 whoverformat

Sets the hover text formatting rulefor w using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘whoverformat’ 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 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.

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 xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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.

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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.

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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.Sunburst(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property branchvalues

Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

The ‘branchvalues’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘remainder’, ‘total’]

Returns

Return type

Any

property count

Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

The ‘count’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘branches’, ‘leaves’] joined with ‘+’ characters (e.g. ‘branches+leaves’)

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 domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.sunburst.Domain

• A dict of string/value properties that will be passed to the Domain constructor

Returns

Return type

plotly.graph_objects.sunburst.Domain

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 [‘label’, ‘text’, ‘value’, ‘name’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.sunburst.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.sunburst.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

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 insidetextfont

Sets the font used for textinfo lying inside the sector.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

• An instance of plotly.graph_objects.sunburst.Insidetextfont

• A dict of string/value properties that will be passed to the Insidetextfont constructor

Returns

Return type

plotly.graph_objects.sunburst.Insidetextfont

property insidetextorientation

Controls the orientation of the text inside chart sectors. When set to “auto”, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The “horizontal” option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The “radial” option orients text along the radius of the sector. The “tangential” option orients text perpendicular to the radius of the sector.

The ‘insidetextorientation’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘horizontal’, ‘radial’, ‘tangential’, ‘auto’]

Returns

Return type

Any

property labels

Sets the labels of each of the sectors.

The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property labelssrc

Sets the source reference on Chart Studio Cloud for labels.

The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property leaf

The ‘leaf’ property is an instance of Leaf that may be specified as:

• An instance of plotly.graph_objects.sunburst.Leaf

• A dict of string/value properties that will be passed to the Leaf constructor

Returns

Return type

plotly.graph_objects.sunburst.Leaf

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.sunburst.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.sunburst.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property level

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

The ‘level’ property accepts values of any type

Returns

Return type

Any

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.sunburst.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.sunburst.Marker

property maxdepth

Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

The ‘maxdepth’ property is a integer and may be specified as:

• An int (or float that will be cast to an int)

Returns

Return type

int

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 appears 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 outsidetextfont

Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:

• An instance of plotly.graph_objects.sunburst.Outsidetextfont

• A dict of string/value properties that will be passed to the Outsidetextfont constructor

Returns

Return type

plotly.graph_objects.sunburst.Outsidetextfont

property parents

Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

The ‘parents’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property parentssrc

Sets the source reference on Chart Studio Cloud for parents.

The ‘parentssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property root

The ‘root’ property is an instance of Root that may be specified as:

• An instance of plotly.graph_objects.sunburst.Root

• A dict of string/value properties that will be passed to the Root constructor

Returns

Return type

plotly.graph_objects.sunburst.Root

property rotation

Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o’clock.

The ‘rotation’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns

Return type

int|float

property sort

Determines whether or not the sectors are reordered from largest to smallest.

The ‘sort’ property must be specified as a bool (either True, or False)

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.sunburst.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.sunburst.Stream

property text

Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property textfont

Sets the font used for textinfo.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.sunburst.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.sunburst.Textfont

property textinfo

Determines which trace information appear on the graph.

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘value’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 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 values

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property valuessrc

Sets the source reference on Chart Studio Cloud for values.

The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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

class plotly.graph_objects.Surface(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 cauto

Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

The ‘cauto’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property cmax

Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmin must be set as well.

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 z or surfacecolor. 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 z or surfacecolor 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

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.surface.ColorBar

• A dict of string/value properties that will be passed to the ColorBar constructor

Returns

Return type

plotly.graph_objects.surface.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

The ‘colorscale’ property is a colorscale and may be specified as:

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property connectgaps

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in.

The ‘connectgaps’ property must be specified as a bool (either True, or False)

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.surface.Contours

• A dict of string/value properties that will be passed to the Contours constructor

Returns

Return type

plotly.graph_objects.surface.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 hidesurface

Determines whether or not a surface is drawn. For example, set hidesurface to False contours.x.show to True and contours.y.show to True to draw a wire frame plot.

The ‘hidesurface’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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.surface.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.surface.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.surface.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.surface.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property lighting

The ‘lighting’ property is an instance of Lighting that may be specified as:

• An instance of plotly.graph_objects.surface.Lighting

• A dict of string/value properties that will be passed to the Lighting constructor

Returns

Return type

plotly.graph_objects.surface.Lighting

property lightposition

The ‘lightposition’ property is an instance of Lightposition that may be specified as:

• An instance of plotly.graph_objects.surface.Lightposition

• A dict of string/value properties that will be passed to the Lightposition constructor

Returns

Return type

plotly.graph_objects.surface.Lightposition

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 appears 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 opacityscale

Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The default is ‘uniform’.

The ‘opacityscale’ property accepts values of any type

Returns

Return type

Any

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 stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.surface.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.surface.Stream

property surfacecolor

Sets the surface color values, used for setting a color scale independent of z.

The ‘surfacecolor’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property surfacecolorsrc

Sets the source reference on Chart Studio Cloud for surfacecolor.

The ‘surfacecolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property text

Sets the text elements associated with each z value. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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

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

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 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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 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:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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.

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 zcalendar

Sets the calendar system to use with z date data.

The ‘zcalendar’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns

Return type

Any

property zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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.Table(arg=None, cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property cells

The ‘cells’ property is an instance of Cells that may be specified as:

• An instance of plotly.graph_objects.table.Cells

• A dict of string/value properties that will be passed to the Cells constructor

Returns

Return type

plotly.graph_objects.table.Cells

property columnorder

Specifies the rendered order of the data columns; for example, a value 2 at position 0 means that column index 0 in the data will be rendered as the third column, as columns have an index base of zero.

The ‘columnorder’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property columnordersrc

Sets the source reference on Chart Studio Cloud for columnorder.

The ‘columnordersrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property columnwidth

The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

The ‘columnwidth’ 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 columnwidthsrc

Sets the source reference on Chart Studio Cloud for columnwidth.

The ‘columnwidthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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 domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.table.Domain

• A dict of string/value properties that will be passed to the Domain constructor

Returns

Return type

plotly.graph_objects.table.Domain

property header

The ‘header’ property is an instance of Header that may be specified as:

• An instance of plotly.graph_objects.table.Header

• A dict of string/value properties that will be passed to the Header constructor

Returns

Return type

plotly.graph_objects.table.Header

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.table.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.table.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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.table.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.table.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

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 appears 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 stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.table.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.table.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

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.Trace(*args, **kwargs)

Bases: dict

plotly.graph_objects.Trace is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.Scatter

• plotly.graph_objects.Bar

• plotly.graph_objects.Area

• plotly.graph_objects.Histogram

• etc.

class plotly.graph_objects.Treemap(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

property branchvalues

Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

The ‘branchvalues’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘remainder’, ‘total’]

Returns

Return type

Any

property count

Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.

The ‘count’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘branches’, ‘leaves’] joined with ‘+’ characters (e.g. ‘branches+leaves’)

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 domain

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.treemap.Domain

• A dict of string/value properties that will be passed to the Domain constructor

Returns

Return type

plotly.graph_objects.treemap.Domain

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 [‘label’, ‘text’, ‘value’, ‘name’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.treemap.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.treemap.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.

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 insidetextfont

Sets the font used for textinfo lying inside the sector.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

• An instance of plotly.graph_objects.treemap.Insidetextfont

• A dict of string/value properties that will be passed to the Insidetextfont constructor

Returns

Return type

plotly.graph_objects.treemap.Insidetextfont

property labels

Sets the labels of each of the sectors.

The ‘labels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property labelssrc

Sets the source reference on Chart Studio Cloud for labels.

The ‘labelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.treemap.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.treemap.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property level

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

The ‘level’ property accepts values of any type

Returns

Return type

Any

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.treemap.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.treemap.Marker

property maxdepth

Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.

The ‘maxdepth’ property is a integer and may be specified as:

• An int (or float that will be cast to an int)

Returns

Return type

int

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 appears 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 outsidetextfont

Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

The ‘outsidetextfont’ property is an instance of Outsidetextfont that may be specified as:

• An instance of plotly.graph_objects.treemap.Outsidetextfont

• A dict of string/value properties that will be passed to the Outsidetextfont constructor

Returns

Return type

plotly.graph_objects.treemap.Outsidetextfont

property parents

Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

The ‘parents’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property parentssrc

Sets the source reference on Chart Studio Cloud for parents.

The ‘parentssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property pathbar

The ‘pathbar’ property is an instance of Pathbar that may be specified as:

• An instance of plotly.graph_objects.treemap.Pathbar

• A dict of string/value properties that will be passed to the Pathbar constructor

Returns

Return type

plotly.graph_objects.treemap.Pathbar

property root

The ‘root’ property is an instance of Root that may be specified as:

• An instance of plotly.graph_objects.treemap.Root

• A dict of string/value properties that will be passed to the Root constructor

Returns

Return type

plotly.graph_objects.treemap.Root

property sort

Determines whether or not the sectors are reordered from largest to smallest.

The ‘sort’ property must be specified as a bool (either True, or False)

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.treemap.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.treemap.Stream

property text

Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

The ‘text’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property textfont

Sets the font used for textinfo.

The ‘textfont’ property is an instance of Textfont that may be specified as:

• An instance of plotly.graph_objects.treemap.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.treemap.Textfont

property textinfo

Determines which trace information appear on the graph.

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘value’, ‘current path’, ‘percent root’, ‘percent entry’, ‘percent parent’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property textposition

Sets the positions of the text elements.

The ‘textposition’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]

Returns

Return type

Any

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 tiling

The ‘tiling’ property is an instance of Tiling that may be specified as:

• An instance of plotly.graph_objects.treemap.Tiling

• A dict of string/value properties that will be passed to the Tiling constructor

Returns

Return type

plotly.graph_objects.treemap.Tiling

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 values

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property valuessrc

Sets the source reference on Chart Studio Cloud for values.

The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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

class plotly.graph_objects.Violin(arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 bandwidth

Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman’s rule of thumb.

The ‘bandwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property box

The ‘box’ property is an instance of Box that may be specified as:

• An instance of plotly.graph_objects.violin.Box

• A dict of string/value properties that will be passed to the Box constructor

Returns

Return type

plotly.graph_objects.violin.Box

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 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: see https://plotly.com/python/css-colors/ for a list

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.violin.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.violin.Hoverlabel

property hoveron

Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

The ‘hoveron’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘violins’, ‘points’, ‘kde’] joined with ‘+’ characters (e.g. ‘violins+points’) OR exactly one of [‘all’] (e.g. ‘all’)

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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 violins.

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 legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.violin.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.violin.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property line

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.violin.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.violin.Line

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

• An instance of plotly.graph_objects.violin.Marker

• A dict of string/value properties that will be passed to the Marker constructor

Returns

Return type

plotly.graph_objects.violin.Marker

property meanline

The ‘meanline’ property is an instance of Meanline that may be specified as:

• An instance of plotly.graph_objects.violin.Meanline

• A dict of string/value properties that will be passed to the Meanline constructor

Returns

Return type

plotly.graph_objects.violin.Meanline

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 appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute scalegroup (please see its description for details).

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 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 violin(s). 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 violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

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 points

If “outliers”, only the sample points lying outside the whiskers are shown If “suspectedoutliers”, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all sample points are shown If False, only the violins are shown with no sample points. Defaults to “suspectedoutliers” when marker.outliercolor or marker.line.outliercolor is set, otherwise defaults to “outliers”.

The ‘points’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘all’, ‘outliers’, ‘suspectedoutliers’, False]

Returns

Return type

Any

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://jse.amstat.org/v14n3/langford.html). The “exclusive” method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The “inclusive” method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

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 scalegroup

If there are multiple violins that should be sized according to to some metric (see scalemode), link them by providing a non- empty group id here shared by every trace in the same group. If a violin’s width is undefined, scalegroup will default to the trace’s name. In this case, violins with the same names will be linked together

The ‘scalegroup’ 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 scalemode

Sets the metric by which the width of each violin is determined. “width” means each violin has the same (max) width “count” means the violins are scaled by the number of sample points making up each violin.

The ‘scalemode’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘width’, ‘count’]

Returns

Return type

Any

property selected

The ‘selected’ property is an instance of Selected that may be specified as:

• An instance of plotly.graph_objects.violin.Selected

• A dict of string/value properties that will be passed to the Selected constructor

Returns

Return type

plotly.graph_objects.violin.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 side

Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under “overlay” mode, where one trace has side set to “positive” and the other to “negative”.

The ‘side’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘both’, ‘positive’, ‘negative’]

Returns

Return type

Any

property span

Sets the span in data space for which the density function will

be computed. Has an effect only when spanmode is set to “manual”.

The ‘span’ property is an info array that may be specified as:

• a list or tuple of 2 elements where:

0. The ‘span[0]’ property accepts values of any type

1. The ‘span[1]’ property accepts values of any type

   list

property spanmode

Sets the method by which the span in data space where the density function will be computed. “soft” means the span goes from the sample’s minimum value minus two bandwidths to the sample’s maximum value plus two bandwidths. “hard” means the span goes from the sample’s minimum to its maximum value. For custom span settings, use mode “manual” and fill in the span attribute.

The ‘spanmode’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘soft’, ‘hard’, ‘manual’]

Returns

Return type

Any

property stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.violin.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.violin.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

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 unselected

The ‘unselected’ property is an instance of Unselected that may be specified as:

• An instance of plotly.graph_objects.violin.Unselected

• A dict of string/value properties that will be passed to the Unselected constructor

Returns

Return type

plotly.graph_objects.violin.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 width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

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

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 xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

The ‘zorder’ property is a integer and may be specified as:

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.Volume(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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 caps

The ‘caps’ property is an instance of Caps that may be specified as:

• An instance of plotly.graph_objects.volume.Caps

• A dict of string/value properties that will be passed to the Caps constructor

Returns

Return type

plotly.graph_objects.volume.Caps

property cauto

Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

The ‘cauto’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property cmax

Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

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 value. 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 value 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

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.volume.ColorBar

• A dict of string/value properties that will be passed to the ColorBar constructor

Returns

Return type

plotly.graph_objects.volume.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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

The ‘colorscale’ property is a colorscale and may be specified as:

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property contour

The ‘contour’ property is an instance of Contour that may be specified as:

• An instance of plotly.graph_objects.volume.Contour

• A dict of string/value properties that will be passed to the Contour constructor

Returns

Return type

plotly.graph_objects.volume.Contour

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 flatshading

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

The ‘flatshading’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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.volume.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.volume.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 isomax

Sets the maximum boundary for iso-surface plot.

The ‘isomax’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property isomin

Sets the minimum boundary for iso-surface plot.

The ‘isomin’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.volume.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.volume.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property lighting

The ‘lighting’ property is an instance of Lighting that may be specified as:

• An instance of plotly.graph_objects.volume.Lighting

• A dict of string/value properties that will be passed to the Lighting constructor

Returns

Return type

plotly.graph_objects.volume.Lighting

property lightposition

The ‘lightposition’ property is an instance of Lightposition that may be specified as:

• An instance of plotly.graph_objects.volume.Lightposition

• A dict of string/value properties that will be passed to the Lightposition constructor

Returns

Return type

plotly.graph_objects.volume.Lightposition

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 appears 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 opacityscale

Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. The default is ‘uniform’.

The ‘opacityscale’ property accepts values of any type

Returns

Return type

Any

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 slices

The ‘slices’ property is an instance of Slices that may be specified as:

• An instance of plotly.graph_objects.volume.Slices

• A dict of string/value properties that will be passed to the Slices constructor

Returns

Return type

plotly.graph_objects.volume.Slices

property spaceframe

The ‘spaceframe’ property is an instance of Spaceframe that may be specified as:

• An instance of plotly.graph_objects.volume.Spaceframe

• A dict of string/value properties that will be passed to the Spaceframe constructor

Returns

Return type

plotly.graph_objects.volume.Spaceframe

property stream

The ‘stream’ property is an instance of Stream that may be specified as:

• An instance of plotly.graph_objects.volume.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.volume.Stream

property surface

The ‘surface’ property is an instance of Surface that may be specified as:

• An instance of plotly.graph_objects.volume.Surface

• A dict of string/value properties that will be passed to the Surface constructor

Returns

Return type

plotly.graph_objects.volume.Surface

property text

Sets the text elements associated with the vertices. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.

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

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 value

Sets the 4th dimension (value) of the vertices.

The ‘value’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property valuehoverformat

Sets the hover text formatting rulefor value using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.

The ‘valuehoverformat’ 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 valuesrc

Sets the source reference on Chart Studio Cloud for value.

The ‘valuesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

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 x

Sets the X coordinates of the vertices on X axis.

The ‘x’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 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 vertices on Y axis.

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 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 vertices on Z axis.

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 zhoverformat

Sets the hover text formatting rulefor z using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using zaxis.hoverformat.

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 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.Waterfall(arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceType

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).

The ‘base’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

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 connector

The ‘connector’ property is an instance of Connector that may be specified as:

• An instance of plotly.graph_objects.waterfall.Connector

• A dict of string/value properties that will be passed to the Connector constructor

Returns

Return type

plotly.graph_objects.waterfall.Connector

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 decreasing

The ‘decreasing’ property is an instance of Decreasing that may be specified as:

• An instance of plotly.graph_objects.waterfall.Decreasing

• A dict of string/value properties that will be passed to the Decreasing constructor

Returns

Return type

plotly.graph_objects.waterfall.Decreasing

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 hoverinfo

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘name’, ‘x’, ‘y’, ‘text’, ‘initial’, ‘delta’, ‘final’] joined with ‘+’ characters (e.g. ‘name+x’) OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)

• A list or array of the above

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.waterfall.Hoverlabel

• A dict of string/value properties that will be passed to the Hoverlabel constructor

Returns

Return type

plotly.graph_objects.waterfall.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}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta and final. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 hovertemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 increasing

The ‘increasing’ property is an instance of Increasing that may be specified as:

• An instance of plotly.graph_objects.waterfall.Increasing

• A dict of string/value properties that will be passed to the Increasing constructor

Returns

Return type

plotly.graph_objects.waterfall.Increasing

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.waterfall.Insidetextfont

• A dict of string/value properties that will be passed to the Insidetextfont constructor

Returns

Return type

plotly.graph_objects.waterfall.Insidetextfont

property legend

Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

The ‘legend’ property is an identifier of a particular subplot, of type ‘legend’, that may be specified as the string ‘legend’ optionally followed by an integer >= 1 (e.g. ‘legend’, ‘legend1’, ‘legend2’, ‘legend3’, etc.)

Returns

Return type

str

property legendgroup

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

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 legendgrouptitle

The ‘legendgrouptitle’ property is an instance of Legendgrouptitle that may be specified as:

• An instance of plotly.graph_objects.waterfall.Legendgrouptitle

• A dict of string/value properties that will be passed to the Legendgrouptitle constructor

Returns

Return type

plotly.graph_objects.waterfall.Legendgrouptitle

property legendrank

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

The ‘legendrank’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property legendwidth

Sets the width (in px or fraction) of the legend for this trace.

The ‘legendwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property measure

An array containing types of values. By default the values are considered as ‘relative’. However; it is possible to use ‘total’ to compute the sums. Also ‘absolute’ could be applied to reset the computed total or to declare an initial value where needed.

The ‘measure’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property measuresrc

Sets the source reference on Chart Studio Cloud for measure.

The ‘measuresrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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 appears 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.waterfall.Outsidetextfont

• A dict of string/value properties that will be passed to the Outsidetextfont constructor

Returns

Return type

plotly.graph_objects.waterfall.Outsidetextfont

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.waterfall.Stream

• A dict of string/value properties that will be passed to the Stream constructor

Returns

Return type

plotly.graph_objects.waterfall.Stream

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.waterfall.Textfont

• A dict of string/value properties that will be passed to the Textfont constructor

Returns

Return type

plotly.graph_objects.waterfall.Textfont

property textinfo

Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

The ‘textinfo’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘label’, ‘text’, ‘initial’, ‘delta’, ‘final’] joined with ‘+’ characters (e.g. ‘label+text’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

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. If “none”, no text appears.

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 appears on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta, final and label.

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 texttemplatefallback

Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

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 totals

The ‘totals’ property is an instance of Totals that may be specified as:

• An instance of plotly.graph_objects.waterfall.Totals

• A dict of string/value properties that will be passed to the Totals constructor

Returns

Return type

plotly.graph_objects.waterfall.Totals

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

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 xhoverformat

Sets the hover text formatting rulefor x using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using xaxis.hoverformat.

The ‘xhoverformat’ 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 xperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the x axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘xperiod’ property accepts values of any type

Returns

Return type

Any

property xperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘xperiod0’ property accepts values of any type

Returns

Return type

Any

property xperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the x axis.

The ‘xperiodalignment’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 yhoverformat

Sets the hover text formatting rulefor y using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display *09~15~23.46*By default the values are formatted using yaxis.hoverformat.

The ‘yhoverformat’ 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 yperiod

Only relevant when the axis type is “date”. Sets the period positioning in milliseconds or “M<n>” on the y axis. Special values in the form of “M<n>” could be used to declare the number of months. In this case n must be a positive integer.

The ‘yperiod’ property accepts values of any type

Returns

Return type

Any

property yperiod0

Only relevant when the axis type is “date”. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

The ‘yperiod0’ property accepts values of any type

Returns

Return type

Any

property yperiodalignment

Only relevant when the axis type is “date”. Sets the alignment of data points on the y axis.

The ‘yperiodalignment’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘start’, ‘middle’, ‘end’]

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 zorder

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

The ‘zorder’ property is a integer and may be specified as:

• An int (or float that will be cast to an int)

Returns

Return type

int

class plotly.graph_objects.XAxis(*args, **kwargs)

Bases: dict

plotly.graph_objects.XAxis is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.XAxis

• plotly.graph_objects.layout.scene.XAxis

class plotly.graph_objects.XBins(*args, **kwargs)

Bases: dict

plotly.graph_objects.XBins is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.histogram.XBins

• plotly.graph_objects.histogram2d.XBins

class plotly.graph_objects.YAxis(*args, **kwargs)

Bases: dict

plotly.graph_objects.YAxis is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.YAxis

• plotly.graph_objects.layout.scene.YAxis

class plotly.graph_objects.YBins(*args, **kwargs)

Bases: dict

plotly.graph_objects.YBins is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.histogram.YBins

• plotly.graph_objects.histogram2d.YBins

class plotly.graph_objects.ZAxis(*args, **kwargs)

Bases: dict

plotly.graph_objects.ZAxis is deprecated.

Please replace it with one of the following more specific types

• plotly.graph_objects.layout.scene.ZAxis

Subpackages

• plotly.graph_objects.bar package
  • Subpackages
    • plotly.graph_objects.bar.hoverlabel package
    • plotly.graph_objects.bar.legendgrouptitle package
    • plotly.graph_objects.bar.marker package
      • Subpackages
    • plotly.graph_objects.bar.selected package
    • plotly.graph_objects.bar.unselected package
• plotly.graph_objects.barpolar package
  • Subpackages
    • plotly.graph_objects.barpolar.hoverlabel package
    • plotly.graph_objects.barpolar.legendgrouptitle package
    • plotly.graph_objects.barpolar.marker package
      • Subpackages
    • plotly.graph_objects.barpolar.selected package
    • plotly.graph_objects.barpolar.unselected package
• plotly.graph_objects.box package
  • Subpackages
    • plotly.graph_objects.box.hoverlabel package
    • plotly.graph_objects.box.legendgrouptitle package
    • plotly.graph_objects.box.marker package
    • plotly.graph_objects.box.selected package
    • plotly.graph_objects.box.unselected package
• plotly.graph_objects.candlestick package
  • Subpackages
    • plotly.graph_objects.candlestick.decreasing package
    • plotly.graph_objects.candlestick.hoverlabel package
    • plotly.graph_objects.candlestick.increasing package
    • plotly.graph_objects.candlestick.legendgrouptitle package
• plotly.graph_objects.carpet package
  • Subpackages
    • plotly.graph_objects.carpet.aaxis package
      • Subpackages
    • plotly.graph_objects.carpet.baxis package
      • Subpackages
    • plotly.graph_objects.carpet.legendgrouptitle package
• plotly.graph_objects.choropleth package
  • Subpackages
    • plotly.graph_objects.choropleth.colorbar package
      • Subpackages
    • plotly.graph_objects.choropleth.hoverlabel package
    • plotly.graph_objects.choropleth.legendgrouptitle package
    • plotly.graph_objects.choropleth.marker package
    • plotly.graph_objects.choropleth.selected package
    • plotly.graph_objects.choropleth.unselected package
• plotly.graph_objects.choroplethmap package
  • Subpackages
    • plotly.graph_objects.choroplethmap.colorbar package
      • Subpackages
    • plotly.graph_objects.choroplethmap.hoverlabel package
    • plotly.graph_objects.choroplethmap.legendgrouptitle package
    • plotly.graph_objects.choroplethmap.marker package
    • plotly.graph_objects.choroplethmap.selected package
    • plotly.graph_objects.choroplethmap.unselected package
• plotly.graph_objects.choroplethmapbox package
  • Subpackages
    • plotly.graph_objects.choroplethmapbox.colorbar package
      • Subpackages
    • plotly.graph_objects.choroplethmapbox.hoverlabel package
    • plotly.graph_objects.choroplethmapbox.legendgrouptitle package
    • plotly.graph_objects.choroplethmapbox.marker package
    • plotly.graph_objects.choroplethmapbox.selected package
    • plotly.graph_objects.choroplethmapbox.unselected package
• plotly.graph_objects.cone package
  • Subpackages
    • plotly.graph_objects.cone.colorbar package
      • Subpackages
    • plotly.graph_objects.cone.hoverlabel package
    • plotly.graph_objects.cone.legendgrouptitle package
• plotly.graph_objects.contour package
  • Subpackages
    • plotly.graph_objects.contour.colorbar package
      • Subpackages
    • plotly.graph_objects.contour.contours package
    • plotly.graph_objects.contour.hoverlabel package
    • plotly.graph_objects.contour.legendgrouptitle package
• plotly.graph_objects.contourcarpet package
  • Subpackages
    • plotly.graph_objects.contourcarpet.colorbar package
      • Subpackages
    • plotly.graph_objects.contourcarpet.contours package
    • plotly.graph_objects.contourcarpet.legendgrouptitle package
• plotly.graph_objects.densitymap package
  • Subpackages
    • plotly.graph_objects.densitymap.colorbar package
      • Subpackages
    • plotly.graph_objects.densitymap.hoverlabel package
    • plotly.graph_objects.densitymap.legendgrouptitle package
• plotly.graph_objects.densitymapbox package
  • Subpackages
    • plotly.graph_objects.densitymapbox.colorbar package
      • Subpackages
    • plotly.graph_objects.densitymapbox.hoverlabel package
    • plotly.graph_objects.densitymapbox.legendgrouptitle package
• plotly.graph_objects.funnel package
  • Subpackages
    • plotly.graph_objects.funnel.connector package
    • plotly.graph_objects.funnel.hoverlabel package
    • plotly.graph_objects.funnel.legendgrouptitle package
    • plotly.graph_objects.funnel.marker package
      • Subpackages
• plotly.graph_objects.funnelarea package
  • Subpackages
    • plotly.graph_objects.funnelarea.hoverlabel package
    • plotly.graph_objects.funnelarea.legendgrouptitle package
    • plotly.graph_objects.funnelarea.marker package
    • plotly.graph_objects.funnelarea.title package
• plotly.graph_objects.heatmap package
  • Subpackages
    • plotly.graph_objects.heatmap.colorbar package
      • Subpackages
    • plotly.graph_objects.heatmap.hoverlabel package
    • plotly.graph_objects.heatmap.legendgrouptitle package
• plotly.graph_objects.histogram package
  • Subpackages
    • plotly.graph_objects.histogram.hoverlabel package
    • plotly.graph_objects.histogram.legendgrouptitle package
    • plotly.graph_objects.histogram.marker package
      • Subpackages
    • plotly.graph_objects.histogram.selected package
    • plotly.graph_objects.histogram.unselected package
• plotly.graph_objects.histogram2d package
  • Subpackages
    • plotly.graph_objects.histogram2d.colorbar package
      • Subpackages
    • plotly.graph_objects.histogram2d.hoverlabel package
    • plotly.graph_objects.histogram2d.legendgrouptitle package
• plotly.graph_objects.histogram2dcontour package
  • Subpackages
    • plotly.graph_objects.histogram2dcontour.colorbar package
      • Subpackages
    • plotly.graph_objects.histogram2dcontour.contours package
    • plotly.graph_objects.histogram2dcontour.hoverlabel package
    • plotly.graph_objects.histogram2dcontour.legendgrouptitle package
• plotly.graph_objects.icicle package
  • Subpackages
    • plotly.graph_objects.icicle.hoverlabel package
    • plotly.graph_objects.icicle.legendgrouptitle package
    • plotly.graph_objects.icicle.marker package
      • Subpackages
    • plotly.graph_objects.icicle.pathbar package
• plotly.graph_objects.image package
  • Subpackages
    • plotly.graph_objects.image.hoverlabel package
    • plotly.graph_objects.image.legendgrouptitle package
• plotly.graph_objects.indicator package
  • Subpackages
    • plotly.graph_objects.indicator.delta package
    • plotly.graph_objects.indicator.gauge package
      • Subpackages
    • plotly.graph_objects.indicator.legendgrouptitle package
    • plotly.graph_objects.indicator.number package
    • plotly.graph_objects.indicator.title package
• plotly.graph_objects.isosurface package
  • Subpackages
    • plotly.graph_objects.isosurface.caps package
    • plotly.graph_objects.isosurface.colorbar package
      • Subpackages
    • plotly.graph_objects.isosurface.hoverlabel package
    • plotly.graph_objects.isosurface.legendgrouptitle package
    • plotly.graph_objects.isosurface.slices package
• plotly.graph_objects.layout package
  • Subpackages
    • plotly.graph_objects.layout.annotation package
      • Subpackages
    • plotly.graph_objects.layout.coloraxis package
      • Subpackages
    • plotly.graph_objects.layout.geo package
      • Subpackages
    • plotly.graph_objects.layout.grid package
    • plotly.graph_objects.layout.hoverlabel package
    • plotly.graph_objects.layout.legend package
      • Subpackages
    • plotly.graph_objects.layout.map package
      • Subpackages
    • plotly.graph_objects.layout.mapbox package
      • Subpackages
    • plotly.graph_objects.layout.newselection package
    • plotly.graph_objects.layout.newshape package
      • Subpackages
    • plotly.graph_objects.layout.polar package
      • Subpackages
    • plotly.graph_objects.layout.scene package
      • Subpackages
    • plotly.graph_objects.layout.selection package
    • plotly.graph_objects.layout.shape package
      • Subpackages
    • plotly.graph_objects.layout.slider package
      • Subpackages
    • plotly.graph_objects.layout.smith package
      • Subpackages
    • plotly.graph_objects.layout.template package
      • Subpackages
    • plotly.graph_objects.layout.ternary package
      • Subpackages
    • plotly.graph_objects.layout.title package
      • Subpackages
    • plotly.graph_objects.layout.updatemenu package
    • plotly.graph_objects.layout.xaxis package
      • Subpackages
    • plotly.graph_objects.layout.yaxis package
      • Subpackages
• plotly.graph_objects.mesh3d package
  • Subpackages
    • plotly.graph_objects.mesh3d.colorbar package
      • Subpackages
    • plotly.graph_objects.mesh3d.hoverlabel package
    • plotly.graph_objects.mesh3d.legendgrouptitle package
• plotly.graph_objects.ohlc package
  • Subpackages
    • plotly.graph_objects.ohlc.decreasing package
    • plotly.graph_objects.ohlc.hoverlabel package
    • plotly.graph_objects.ohlc.increasing package
    • plotly.graph_objects.ohlc.legendgrouptitle package
• plotly.graph_objects.parcats package
  • Subpackages
    • plotly.graph_objects.parcats.legendgrouptitle package
    • plotly.graph_objects.parcats.line package
      • Subpackages
• plotly.graph_objects.parcoords package
  • Subpackages
    • plotly.graph_objects.parcoords.legendgrouptitle package
    • plotly.graph_objects.parcoords.line package
      • Subpackages
    • plotly.graph_objects.parcoords.unselected package
• plotly.graph_objects.pie package
  • Subpackages
    • plotly.graph_objects.pie.hoverlabel package
    • plotly.graph_objects.pie.legendgrouptitle package
    • plotly.graph_objects.pie.marker package
    • plotly.graph_objects.pie.title package
• plotly.graph_objects.sankey package
  • Subpackages
    • plotly.graph_objects.sankey.hoverlabel package
    • plotly.graph_objects.sankey.legendgrouptitle package
    • plotly.graph_objects.sankey.link package
      • Subpackages
    • plotly.graph_objects.sankey.node package
      • Subpackages
• plotly.graph_objects.scatter package
  • Subpackages
    • plotly.graph_objects.scatter.hoverlabel package
    • plotly.graph_objects.scatter.legendgrouptitle package
    • plotly.graph_objects.scatter.marker package
      • Subpackages
    • plotly.graph_objects.scatter.selected package
    • plotly.graph_objects.scatter.unselected package
• plotly.graph_objects.scatter3d package
  • Subpackages
    • plotly.graph_objects.scatter3d.hoverlabel package
    • plotly.graph_objects.scatter3d.legendgrouptitle package
    • plotly.graph_objects.scatter3d.line package
      • Subpackages
    • plotly.graph_objects.scatter3d.marker package
      • Subpackages
    • plotly.graph_objects.scatter3d.projection package
• plotly.graph_objects.scattercarpet package
  • Subpackages
    • plotly.graph_objects.scattercarpet.hoverlabel package
    • plotly.graph_objects.scattercarpet.legendgrouptitle package
    • plotly.graph_objects.scattercarpet.marker package
      • Subpackages
    • plotly.graph_objects.scattercarpet.selected package
    • plotly.graph_objects.scattercarpet.unselected package
• plotly.graph_objects.scattergeo package
  • Subpackages
    • plotly.graph_objects.scattergeo.hoverlabel package
    • plotly.graph_objects.scattergeo.legendgrouptitle package
    • plotly.graph_objects.scattergeo.marker package
      • Subpackages
    • plotly.graph_objects.scattergeo.selected package
    • plotly.graph_objects.scattergeo.unselected package
• plotly.graph_objects.scattergl package
  • Subpackages
    • plotly.graph_objects.scattergl.hoverlabel package
    • plotly.graph_objects.scattergl.legendgrouptitle package
    • plotly.graph_objects.scattergl.marker package
      • Subpackages
    • plotly.graph_objects.scattergl.selected package
    • plotly.graph_objects.scattergl.unselected package
• plotly.graph_objects.scattermap package
  • Subpackages
    • plotly.graph_objects.scattermap.hoverlabel package
    • plotly.graph_objects.scattermap.legendgrouptitle package
    • plotly.graph_objects.scattermap.marker package
      • Subpackages
    • plotly.graph_objects.scattermap.selected package
    • plotly.graph_objects.scattermap.unselected package
• plotly.graph_objects.scattermapbox package
  • Subpackages
    • plotly.graph_objects.scattermapbox.hoverlabel package
    • plotly.graph_objects.scattermapbox.legendgrouptitle package
    • plotly.graph_objects.scattermapbox.marker package
      • Subpackages
    • plotly.graph_objects.scattermapbox.selected package
    • plotly.graph_objects.scattermapbox.unselected package
• plotly.graph_objects.scatterpolar package
  • Subpackages
    • plotly.graph_objects.scatterpolar.hoverlabel package
    • plotly.graph_objects.scatterpolar.legendgrouptitle package
    • plotly.graph_objects.scatterpolar.marker package
      • Subpackages
    • plotly.graph_objects.scatterpolar.selected package
    • plotly.graph_objects.scatterpolar.unselected package
• plotly.graph_objects.scatterpolargl package
  • Subpackages
    • plotly.graph_objects.scatterpolargl.hoverlabel package
    • plotly.graph_objects.scatterpolargl.legendgrouptitle package
    • plotly.graph_objects.scatterpolargl.marker package
      • Subpackages
    • plotly.graph_objects.scatterpolargl.selected package
    • plotly.graph_objects.scatterpolargl.unselected package
• plotly.graph_objects.scattersmith package
  • Subpackages
    • plotly.graph_objects.scattersmith.hoverlabel package
    • plotly.graph_objects.scattersmith.legendgrouptitle package
    • plotly.graph_objects.scattersmith.marker package
      • Subpackages
    • plotly.graph_objects.scattersmith.selected package
    • plotly.graph_objects.scattersmith.unselected package
• plotly.graph_objects.scatterternary package
  • Subpackages
    • plotly.graph_objects.scatterternary.hoverlabel package
    • plotly.graph_objects.scatterternary.legendgrouptitle package
    • plotly.graph_objects.scatterternary.marker package
      • Subpackages
    • plotly.graph_objects.scatterternary.selected package
    • plotly.graph_objects.scatterternary.unselected package
• plotly.graph_objects.splom package
  • Subpackages
    • plotly.graph_objects.splom.dimension package
    • plotly.graph_objects.splom.hoverlabel package
    • plotly.graph_objects.splom.legendgrouptitle package
    • plotly.graph_objects.splom.marker package
      • Subpackages
    • plotly.graph_objects.splom.selected package
    • plotly.graph_objects.splom.unselected package
• plotly.graph_objects.streamtube package
  • Subpackages
    • plotly.graph_objects.streamtube.colorbar package
      • Subpackages
    • plotly.graph_objects.streamtube.hoverlabel package
    • plotly.graph_objects.streamtube.legendgrouptitle package
• plotly.graph_objects.sunburst package
  • Subpackages
    • plotly.graph_objects.sunburst.hoverlabel package
    • plotly.graph_objects.sunburst.legendgrouptitle package
    • plotly.graph_objects.sunburst.marker package
      • Subpackages
• plotly.graph_objects.surface package
  • Subpackages
    • plotly.graph_objects.surface.colorbar package
      • Subpackages
    • plotly.graph_objects.surface.contours package
      • Subpackages
    • plotly.graph_objects.surface.hoverlabel package
    • plotly.graph_objects.surface.legendgrouptitle package
• plotly.graph_objects.table package
  • Subpackages
    • plotly.graph_objects.table.cells package
    • plotly.graph_objects.table.header package
    • plotly.graph_objects.table.hoverlabel package
    • plotly.graph_objects.table.legendgrouptitle package
• plotly.graph_objects.treemap package
  • Subpackages
    • plotly.graph_objects.treemap.hoverlabel package
    • plotly.graph_objects.treemap.legendgrouptitle package
    • plotly.graph_objects.treemap.marker package
      • Subpackages
    • plotly.graph_objects.treemap.pathbar package
• plotly.graph_objects.violin package
  • Subpackages
    • plotly.graph_objects.violin.box package
    • plotly.graph_objects.violin.hoverlabel package
    • plotly.graph_objects.violin.legendgrouptitle package
    • plotly.graph_objects.violin.marker package
    • plotly.graph_objects.violin.selected package
    • plotly.graph_objects.violin.unselected package
• plotly.graph_objects.volume package
  • Subpackages
    • plotly.graph_objects.volume.caps package
    • plotly.graph_objects.volume.colorbar package
      • Subpackages
    • plotly.graph_objects.volume.hoverlabel package
    • plotly.graph_objects.volume.legendgrouptitle package
    • plotly.graph_objects.volume.slices package
• plotly.graph_objects.waterfall package
  • Subpackages
    • plotly.graph_objects.waterfall.connector package
    • plotly.graph_objects.waterfall.decreasing package
      • Subpackages
    • plotly.graph_objects.waterfall.hoverlabel package
    • plotly.graph_objects.waterfall.increasing package
      • Subpackages
    • plotly.graph_objects.waterfall.legendgrouptitle package
    • plotly.graph_objects.waterfall.totals package
      • Subpackages

Submodules

plotly.graph_objects.graph_objects module