plotly.graph_objects.layout.template.data package

class plotly.graph_objects.layout.template.data.Bar(arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property insidetextanchor¶

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

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

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

Returns
Return type: Any

property insidetextfont¶

Sets the font used for text lying inside the bar.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

An instance of plotly.graph_objects.bar.Insidetextfont

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

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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Barpolar(arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.layout.template.data.Box(arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property jitter¶

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

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

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

Returns
Return type: int|float

property 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.layout.template.data.Candlestick(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

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

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

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

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.layout.template.data.Cone(arg=None, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable norm Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.layout.template.data.Contour(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

Returns
Return type: numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

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

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property lat¶

Sets the latitude coordinates (in degrees North).

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

Returns
Return type: numpy.ndarray

property latsrc¶

Sets the source reference on Chart Studio Cloud for lat.

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

Returns
Return type: str

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

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property lat¶

Sets the latitude coordinates (in degrees North).

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

Returns
Return type: numpy.ndarray

property latsrc¶

Sets the source reference on Chart Studio Cloud for lat.

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

Returns
Return type: str

property 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.layout.template.data.Funnel(arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious and percentTotal. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property insidetextanchor¶

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

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

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

Returns
Return type: Any

property insidetextfont¶

Sets the font used for text lying inside the bar.

The ‘insidetextfont’ property is an instance of Insidetextfont that may be specified as:

An instance of plotly.graph_objects.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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious, percentTotal, label and value.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Funnelarea(arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Heatmap(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

Returns
Return type: numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

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 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.layout.template.data.Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable binNumber Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label and value.

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 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.layout.template.data.Histogram2d(arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property ids¶

Assigns id labels to 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z

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 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.layout.template.data.Histogram2dContour(arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property ids¶

Assigns id labels to 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

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 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.layout.template.data.Icicle(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Image(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables z, color and colormodel. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

Returns
Return type: numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

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

The ‘zmax[0]’ property is a number and may be specified as:
- An int or float
The ‘zmax[1]’ property is a number and may be specified as:
- An int or float
The ‘zmax[2]’ property is a number and may be specified as:
- An int or float
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:

The ‘zmin[0]’ property is a number and may be specified as:
- An int or float
The ‘zmin[1]’ property is a number and may be specified as:
- An int or float
The ‘zmin[2]’ property is a number and may be specified as:
- An int or float
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.layout.template.data.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.layout.template.data.Isosurface(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.template.data.Mesh3d(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property 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.layout.template.data.Ohlc(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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 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.layout.template.data.Parcats(arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. This value here applies when hovering over dimensions. Note that *categorycount, “colorcount” and “bandcolorcount” are only available when hoveron contains the “color” flagFinally, the template string has access to variables count, probability, category, categorycount, colorcount and bandcolorcount. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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 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.layout.template.data.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.layout.template.data.Pie(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.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.layout.template.data.Scatter(arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scatter3d(arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scattercarpet(arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scattergeo(arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (lon,lat) pair 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon, location and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scattergl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scattermap(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property lat¶

Sets the latitude coordinates (in degrees North).

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

Returns
Return type: numpy.ndarray

property latsrc¶

Sets the source reference on Chart Studio Cloud for lat.

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

Returns
Return type: str

property 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scattermapbox(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property lat¶

Sets the latitude coordinates (in degrees North).

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

Returns
Return type: numpy.ndarray

property latsrc¶

Sets the source reference on Chart Studio Cloud for lat.

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

Returns
Return type: str

property 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scatterpolar(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scatterpolargl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scattersmith(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables real, imag and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Scatterternary(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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.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.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.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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each (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.sum to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary.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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b, c and text.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Splom(arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.layout.template.data.Streamtube(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables tubex, tubey, tubez, tubeu, tubev, tubew, norm and divergence. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

A string
A number that will be converted to a string

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.layout.template.data.Sunburst(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Surface(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.layout.template.data.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.layout.template.data.Treemap(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Sets hover text elements associated with each 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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.layout.template.data.Violin(arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property jitter¶

Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the 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:

The ‘span[0]’ property accepts values of any type
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.layout.template.data.Volume(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

Same as text.

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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.layout.template.data.Waterfall(arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

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. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta and final. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

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

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

Returns
Return type: str|numpy.ndarray

property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for hovertemplate.

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

Returns
Return type: str

property hovertext¶

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

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

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

Returns
Return type: str|numpy.ndarray

property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext.

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

Returns
Return type: str

property ids¶

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

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

Returns
Return type: numpy.ndarray

property idssrc¶

Sets the source reference on Chart Studio Cloud for ids.

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

Returns
Return type: str

property 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 appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta, final and label.

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

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

Returns
Return type: str|numpy.ndarray

property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for texttemplate.

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

Returns
Return type: str

property 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

plotly.graph_objects.layout.template.data package¶