plotly.graph_objects.layout.template package

class plotly.graph_objects.layout.template.Data(arg=None, barpolar=None, bar=None, box=None, candlestick=None, carpet=None, choroplethmapbox=None, choroplethmap=None, choropleth=None, cone=None, contourcarpet=None, contour=None, densitymapbox=None, densitymap=None, funnelarea=None, funnel=None, heatmap=None, histogram2dcontour=None, histogram2d=None, histogram=None, icicle=None, image=None, indicator=None, isosurface=None, mesh3d=None, ohlc=None, parcats=None, parcoords=None, pie=None, sankey=None, scatter3d=None, scattercarpet=None, scattergeo=None, scattergl=None, scattermapbox=None, scattermap=None, scatterpolargl=None, scatterpolar=None, scatter=None, scattersmith=None, scatterternary=None, splom=None, streamtube=None, sunburst=None, surface=None, table=None, treemap=None, violin=None, volume=None, waterfall=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property bar

The ‘bar’ property is a tuple of instances of Bar that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Bar

  • A list or tuple of dicts of string/value properties that will be passed to the Bar constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Bar]

property barpolar

The ‘barpolar’ property is a tuple of instances of Barpolar that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Barpolar

  • A list or tuple of dicts of string/value properties that will be passed to the Barpolar constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Barpolar]

property box

The ‘box’ property is a tuple of instances of Box that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Box

  • A list or tuple of dicts of string/value properties that will be passed to the Box constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Box]

property candlestick

The ‘candlestick’ property is a tuple of instances of Candlestick that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Candlestick

  • A list or tuple of dicts of string/value properties that will be passed to the Candlestick constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Candlestick]

property carpet

The ‘carpet’ property is a tuple of instances of Carpet that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Carpet

  • A list or tuple of dicts of string/value properties that will be passed to the Carpet constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Carpet]

property choropleth

The ‘choropleth’ property is a tuple of instances of Choropleth that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Choropleth

  • A list or tuple of dicts of string/value properties that will be passed to the Choropleth constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Choropleth]

property choroplethmap

The ‘choroplethmap’ property is a tuple of instances of Choroplethmap that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Choroplethmap

  • A list or tuple of dicts of string/value properties that will be passed to the Choroplethmap constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Choroplethmap]

property choroplethmapbox

The ‘choroplethmapbox’ property is a tuple of instances of Choroplethmapbox that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Choroplethmapbox

  • A list or tuple of dicts of string/value properties that will be passed to the Choroplethmapbox constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Choroplethmapbox]

property cone

The ‘cone’ property is a tuple of instances of Cone that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Cone

  • A list or tuple of dicts of string/value properties that will be passed to the Cone constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Cone]

property contour

The ‘contour’ property is a tuple of instances of Contour that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Contour

  • A list or tuple of dicts of string/value properties that will be passed to the Contour constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Contour]

property contourcarpet

The ‘contourcarpet’ property is a tuple of instances of Contourcarpet that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Contourcarpet

  • A list or tuple of dicts of string/value properties that will be passed to the Contourcarpet constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Contourcarpet]

property densitymap

The ‘densitymap’ property is a tuple of instances of Densitymap that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Densitymap

  • A list or tuple of dicts of string/value properties that will be passed to the Densitymap constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Densitymap]

property densitymapbox

The ‘densitymapbox’ property is a tuple of instances of Densitymapbox that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Densitymapbox

  • A list or tuple of dicts of string/value properties that will be passed to the Densitymapbox constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Densitymapbox]

property funnel

The ‘funnel’ property is a tuple of instances of Funnel that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Funnel

  • A list or tuple of dicts of string/value properties that will be passed to the Funnel constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Funnel]

property funnelarea

The ‘funnelarea’ property is a tuple of instances of Funnelarea that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Funnelarea

  • A list or tuple of dicts of string/value properties that will be passed to the Funnelarea constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Funnelarea]

property heatmap

The ‘heatmap’ property is a tuple of instances of Heatmap that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Heatmap

  • A list or tuple of dicts of string/value properties that will be passed to the Heatmap constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Heatmap]

property histogram

The ‘histogram’ property is a tuple of instances of Histogram that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Histogram

  • A list or tuple of dicts of string/value properties that will be passed to the Histogram constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Histogram]

property histogram2d

The ‘histogram2d’ property is a tuple of instances of Histogram2d that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Histogram2d

  • A list or tuple of dicts of string/value properties that will be passed to the Histogram2d constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Histogram2d]

property histogram2dcontour

The ‘histogram2dcontour’ property is a tuple of instances of Histogram2dContour that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Histogram2dContour

  • A list or tuple of dicts of string/value properties that will be passed to the Histogram2dContour constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Histogram2dContour]

property icicle

The ‘icicle’ property is a tuple of instances of Icicle that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Icicle

  • A list or tuple of dicts of string/value properties that will be passed to the Icicle constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Icicle]

property image

The ‘image’ property is a tuple of instances of Image that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Image

  • A list or tuple of dicts of string/value properties that will be passed to the Image constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Image]

property indicator

The ‘indicator’ property is a tuple of instances of Indicator that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Indicator

  • A list or tuple of dicts of string/value properties that will be passed to the Indicator constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Indicator]

property isosurface

The ‘isosurface’ property is a tuple of instances of Isosurface that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Isosurface

  • A list or tuple of dicts of string/value properties that will be passed to the Isosurface constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Isosurface]

property mesh3d

The ‘mesh3d’ property is a tuple of instances of Mesh3d that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Mesh3d

  • A list or tuple of dicts of string/value properties that will be passed to the Mesh3d constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Mesh3d]

property ohlc

The ‘ohlc’ property is a tuple of instances of Ohlc that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Ohlc

  • A list or tuple of dicts of string/value properties that will be passed to the Ohlc constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Ohlc]

property parcats

The ‘parcats’ property is a tuple of instances of Parcats that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Parcats

  • A list or tuple of dicts of string/value properties that will be passed to the Parcats constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Parcats]

property parcoords

The ‘parcoords’ property is a tuple of instances of Parcoords that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Parcoords

  • A list or tuple of dicts of string/value properties that will be passed to the Parcoords constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Parcoords]

property pie

The ‘pie’ property is a tuple of instances of Pie that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Pie

  • A list or tuple of dicts of string/value properties that will be passed to the Pie constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Pie]

property sankey

The ‘sankey’ property is a tuple of instances of Sankey that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Sankey

  • A list or tuple of dicts of string/value properties that will be passed to the Sankey constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Sankey]

property scatter

The ‘scatter’ property is a tuple of instances of Scatter that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatter

  • A list or tuple of dicts of string/value properties that will be passed to the Scatter constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scatter]

property scatter3d

The ‘scatter3d’ property is a tuple of instances of Scatter3d that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatter3d

  • A list or tuple of dicts of string/value properties that will be passed to the Scatter3d constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scatter3d]

property scattercarpet

The ‘scattercarpet’ property is a tuple of instances of Scattercarpet that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattercarpet

  • A list or tuple of dicts of string/value properties that will be passed to the Scattercarpet constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scattercarpet]

property scattergeo

The ‘scattergeo’ property is a tuple of instances of Scattergeo that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattergeo

  • A list or tuple of dicts of string/value properties that will be passed to the Scattergeo constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scattergeo]

property scattergl

The ‘scattergl’ property is a tuple of instances of Scattergl that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattergl

  • A list or tuple of dicts of string/value properties that will be passed to the Scattergl constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scattergl]

property scattermap

The ‘scattermap’ property is a tuple of instances of Scattermap that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattermap

  • A list or tuple of dicts of string/value properties that will be passed to the Scattermap constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scattermap]

property scattermapbox

The ‘scattermapbox’ property is a tuple of instances of Scattermapbox that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattermapbox

  • A list or tuple of dicts of string/value properties that will be passed to the Scattermapbox constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scattermapbox]

property scatterpolar

The ‘scatterpolar’ property is a tuple of instances of Scatterpolar that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatterpolar

  • A list or tuple of dicts of string/value properties that will be passed to the Scatterpolar constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scatterpolar]

property scatterpolargl

The ‘scatterpolargl’ property is a tuple of instances of Scatterpolargl that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatterpolargl

  • A list or tuple of dicts of string/value properties that will be passed to the Scatterpolargl constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scatterpolargl]

property scattersmith

The ‘scattersmith’ property is a tuple of instances of Scattersmith that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scattersmith

  • A list or tuple of dicts of string/value properties that will be passed to the Scattersmith constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scattersmith]

property scatterternary

The ‘scatterternary’ property is a tuple of instances of Scatterternary that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Scatterternary

  • A list or tuple of dicts of string/value properties that will be passed to the Scatterternary constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Scatterternary]

property splom

The ‘splom’ property is a tuple of instances of Splom that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Splom

  • A list or tuple of dicts of string/value properties that will be passed to the Splom constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Splom]

property streamtube

The ‘streamtube’ property is a tuple of instances of Streamtube that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Streamtube

  • A list or tuple of dicts of string/value properties that will be passed to the Streamtube constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Streamtube]

property sunburst

The ‘sunburst’ property is a tuple of instances of Sunburst that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Sunburst

  • A list or tuple of dicts of string/value properties that will be passed to the Sunburst constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Sunburst]

property surface

The ‘surface’ property is a tuple of instances of Surface that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Surface

  • A list or tuple of dicts of string/value properties that will be passed to the Surface constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Surface]

property table

The ‘table’ property is a tuple of instances of Table that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Table

  • A list or tuple of dicts of string/value properties that will be passed to the Table constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Table]

property treemap

The ‘treemap’ property is a tuple of instances of Treemap that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Treemap

  • A list or tuple of dicts of string/value properties that will be passed to the Treemap constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Treemap]

property violin

The ‘violin’ property is a tuple of instances of Violin that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Violin

  • A list or tuple of dicts of string/value properties that will be passed to the Violin constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Violin]

property volume

The ‘volume’ property is a tuple of instances of Volume that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Volume

  • A list or tuple of dicts of string/value properties that will be passed to the Volume constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Volume]

property waterfall

The ‘waterfall’ property is a tuple of instances of Waterfall that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.template.data.Waterfall

  • A list or tuple of dicts of string/value properties that will be passed to the Waterfall constructor

Returns

Return type

tuple[plotly.graph_objects.layout.template.data.Waterfall]

class plotly.graph_objects.layout.template.Layout(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutType

property activeselection

The ‘activeselection’ property is an instance of Activeselection that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Activeselection

property activeshape

The ‘activeshape’ property is an instance of Activeshape that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Activeshape

property annotationdefaults

When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations

The ‘annotationdefaults’ property is an instance of Annotation that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Annotation

property annotations

The ‘annotations’ property is a tuple of instances of Annotation that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.Annotation

  • A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Annotation]

property autosize

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

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

Returns

Return type

bool

property autotypenumbers

Using “strict” a numeric string in trace data is not converted to a number. Using convert types a numeric string in trace data may be treated as a number during automatic axis type detection. This is the default value; however it could be overridden for individual axes.

The ‘autotypenumbers’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘convert types’, ‘strict’]

Returns

Return type

Any

property barcornerradius

Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).

The ‘barcornerradius’ property accepts values of any type

Returns

Return type

Any

property bargap

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

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

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

Returns

Return type

int|float

property bargroupgap

Sets the gap (in plot fraction) between bars of the same location coordinate.

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

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

Returns

Return type

int|float

property barmode

Determines how bars at the same location coordinate are displayed on the graph. With “stack”, the bars are stacked on top of one another With “relative”, the bars are stacked on top of one another, with negative values below the axis, positive values above With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

The ‘barmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘stack’, ‘group’, ‘overlay’, ‘relative’]

Returns

Return type

Any

property barnorm

Sets the normalization for bar traces on the graph. With “fraction”, the value of each bar is divided by the sum of all values at that location coordinate. “percent” is the same but multiplied by 100 to show percentages.

The ‘barnorm’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘’, ‘fraction’, ‘percent’]

Returns

Return type

Any

property boxgap

Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property boxgroupgap

Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property boxmode

Determines how boxes at the same location coordinate are displayed on the graph. If “group”, the boxes are plotted next to one another centered around the shared location. If “overlay”, the boxes are plotted over one another, you might need to set “opacity” to see them multiple boxes. Has no effect on traces that have “width” set.

The ‘boxmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘group’, ‘overlay’]

Returns

Return type

Any

property calendar

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

The ‘calendar’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

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

Returns

Return type

Any

property clickmode

Determines the mode of single click interactions. “event” is the default value and emits the plotly_click event. In addition this mode emits the plotly_selected event in drag modes “lasso” and “select”, but with no event data attached (kept for compatibility reasons). The “select” flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. “select” with hovermode: “x” can be confusing, consider explicitly setting hovermode: “closest” when using this feature. Selection events are sent accordingly as long as “event” flag is set as well. When the “event” flag is missing, plotly_click and plotly_selected events are not fired.

The ‘clickmode’ property is a flaglist and may be specified as a string containing:

  • Any combination of [‘event’, ‘select’] joined with ‘+’ characters (e.g. ‘event+select’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property coloraxis

The ‘coloraxis’ property is an instance of Coloraxis that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Coloraxis

property colorscale

The ‘colorscale’ property is an instance of Colorscale that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Colorscale

property colorway

Sets the default trace colors.

The ‘colorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property computed

Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in “full- json” mode.

The ‘computed’ property accepts values of any type

Returns

Return type

Any

property datarevision

If provided, a changed value tells Plotly.react that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, Plotly.react assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

The ‘datarevision’ property accepts values of any type

Returns

Return type

Any

property dragmode

Determines the mode of drag interactions. “select” and “lasso” apply only to scatter traces with markers or text. “orbit” and “turntable” apply only to 3D scenes.

The ‘dragmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘zoom’, ‘pan’, ‘select’, ‘lasso’, ‘drawclosedpath’, ‘drawopenpath’, ‘drawline’, ‘drawrect’, ‘drawcircle’, ‘orbit’, ‘turntable’, False]

Returns

Return type

Any

property editrevision

true` configuration, other than trace names and axis titles. Defaults to layout.uirevision.

The ‘editrevision’ property accepts values of any type

Returns

Return type

Any

Type

Controls persistence of user-driven changes in `editable

property extendfunnelareacolors

If true, the funnelarea slice colors (whether given by funnelareacolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendiciclecolors

If true, the icicle slice colors (whether given by iciclecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendpiecolors

If true, the pie slice colors (whether given by piecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendsunburstcolors

If true, the sunburst slice colors (whether given by sunburstcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property extendtreemapcolors

If true, the treemap slice colors (whether given by treemapcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

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

Returns

Return type

bool

property font

Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

The ‘font’ property is an instance of Font that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Font

property funnelareacolorway

Sets the default funnelarea slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendfunnelareacolors.

The ‘funnelareacolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property funnelgap

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

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

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

Returns

Return type

int|float

property funnelgroupgap

Sets the gap (in plot fraction) between bars of the same location coordinate.

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

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

Returns

Return type

int|float

property funnelmode

Determines how bars at the same location coordinate are displayed on the graph. With “stack”, the bars are stacked on top of one another With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

The ‘funnelmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘stack’, ‘group’, ‘overlay’]

Returns

Return type

Any

property geo

The ‘geo’ property is an instance of Geo that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Geo

property grid

The ‘grid’ property is an instance of Grid that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Grid

property height

Sets the plot’s height (in px).

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

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

Returns

Return type

int|float

property hiddenlabels

hiddenlabels is the funnelarea & pie chart analog of visible:’legendonly’ but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

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

Returns

Return type

numpy.ndarray

property hiddenlabelssrc

Sets the source reference on Chart Studio Cloud for hiddenlabels.

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

Returns

Return type

str

property hidesources

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart- studio.plotly.com or on-premise).

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

Returns

Return type

bool

property hoverdistance

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point- like objects in case of conflict.

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

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

Returns

Return type

int

property hoverlabel

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

Returns

Return type

plotly.graph_objects.layout.Hoverlabel

property hovermode

Determines the mode of hover interactions. If “closest”, a single hoverlabel will appear for the “closest” point within the hoverdistance. If “x” (or “y”), multiple hoverlabels will appear for multiple points at the “closest” x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If x unified (or y unified), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.

The ‘hovermode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘x’, ‘y’, ‘closest’, False, ‘x unified’, ‘y unified’]

Returns

Return type

Any

property hoversubplots

Determines expansion of hover effects to other subplots If “single” just the axis pair of the primary point is included without overlaying subplots. If “overlaying” all subplots using the main axis and occupying the same space are included. If “axis”, also include stacked subplots using the same axis when hovermode is set to “x”, x unified, “y” or y unified.

The ‘hoversubplots’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘single’, ‘overlaying’, ‘axis’]

Returns

Return type

Any

property iciclecolorway

Sets the default icicle slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendiciclecolors.

The ‘iciclecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property imagedefaults

When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images

The ‘imagedefaults’ property is an instance of Image that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Image

property images

The ‘images’ property is a tuple of instances of Image that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.Image

  • A list or tuple of dicts of string/value properties that will be passed to the Image constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Image]

property legend

The ‘legend’ property is an instance of Legend that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Legend

property map

The ‘map’ property is an instance of Map that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Map

property mapbox

The ‘mapbox’ property is an instance of Mapbox that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Mapbox

property margin

The ‘margin’ property is an instance of Margin that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Margin

property meta

Assigns extra meta information that can be used in various text attributes. Attributes such as the graph, axis and colorbar title.text, annotation text trace.name in legend items, rangeselector, updatemenus and sliders label text all support meta. One can access meta fields using template strings: %{meta[i]} where i is the index of the meta item in question. meta can also be an object for example {key: value} which can be accessed %{meta[key]}.

The ‘meta’ property accepts values of any type

Returns

Return type

Any|numpy.ndarray

property metasrc

Sets the source reference on Chart Studio Cloud for meta.

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

Returns

Return type

str

property minreducedheight

Minimum height of the plot with margin.automargin applied (in px)

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

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

Returns

Return type

int|float

property minreducedwidth

Minimum width of the plot with margin.automargin applied (in px)

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

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

Returns

Return type

int|float

property modebar

The ‘modebar’ property is an instance of Modebar that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Modebar

property newselection

The ‘newselection’ property is an instance of Newselection that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Newselection

property newshape

The ‘newshape’ property is an instance of Newshape that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Newshape

property paper_bgcolor

Sets the background color of the paper where the graph is drawn.

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

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property piecolorway

Sets the default pie slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendpiecolors.

The ‘piecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property plot_bgcolor

Sets the background color of the plotting area in-between x and y axes.

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

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property polar

The ‘polar’ property is an instance of Polar that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Polar

re = <module 're' from '/home/circleci/.pyenv/versions/3.9.23/lib/python3.9/re.py'>
property scattergap

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.

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

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

Returns

Return type

int|float

property scattermode

Determines how scatter points at the same location coordinate are displayed on the graph. With “group”, the scatter points are plotted next to one another centered around the shared location. With “overlay”, the scatter points are plotted over one another, you might need to reduce “opacity” to see multiple scatter points.

The ‘scattermode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘group’, ‘overlay’]

Returns

Return type

Any

property scene

The ‘scene’ property is an instance of Scene that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Scene

property selectdirection

When dragmode is set to “select”, this limits the selection of the drag to horizontal, vertical or diagonal. “h” only allows horizontal selection, “v” only vertical, “d” only diagonal and “any” sets no limit.

The ‘selectdirection’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘h’, ‘v’, ‘d’, ‘any’]

Returns

Return type

Any

property selectiondefaults

When used in a template (as layout.template.layout.selectiondefaults), sets the default property values to use for elements of layout.selections

The ‘selectiondefaults’ property is an instance of Selection that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Selection

property selectionrevision

Controls persistence of user-driven changes in selected points from all traces.

The ‘selectionrevision’ property accepts values of any type

Returns

Return type

Any

property selections

The ‘selections’ property is a tuple of instances of Selection that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.Selection

  • A list or tuple of dicts of string/value properties that will be passed to the Selection constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Selection]

property separators

Sets the decimal and thousand separators. For example, *. * puts a ‘.’ before decimals and a space between thousands. In English locales, dflt is “.,” but other locales may alter this default.

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

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property shapedefaults

When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes

The ‘shapedefaults’ property is an instance of Shape that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Shape

property shapes

The ‘shapes’ property is a tuple of instances of Shape that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.Shape

  • A list or tuple of dicts of string/value properties that will be passed to the Shape constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Shape]

property showlegend

Determines whether or not a legend is drawn. Default is true if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with showlegend: true.

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

Returns

Return type

bool

property sliderdefaults

When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders

The ‘sliderdefaults’ property is an instance of Slider that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Slider

property sliders

The ‘sliders’ property is a tuple of instances of Slider that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.Slider

  • A list or tuple of dicts of string/value properties that will be passed to the Slider constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Slider]

property smith

The ‘smith’ property is an instance of Smith that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Smith

property spikedistance

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area- like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

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

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

Returns

Return type

int

property sunburstcolorway

Sets the default sunburst slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendsunburstcolors.

The ‘sunburstcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property template

Default attributes to be applied to the plot. This should be a dict with format: {'layout': layoutTemplate, 'data': {trace_type: [traceTemplate, ...], ...}} where layoutTemplate is a dict matching the structure of figure.layout and traceTemplate is a dict matching the structure of the trace with type trace_type (e.g. ‘scatter’). Alternatively, this may be specified as an instance of plotly.graph_objects.layout.Template. Trace templates are applied cyclically to traces of each type. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so this can be used to add a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

The ‘template’ property is an instance of Template that may be specified as:

  • An instance of plotly.graph_objects.layout.Template

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

  • The name of a registered template where current registered templates are stored in the plotly.io.templates configuration object. The names of all registered templates can be retrieved with:

    >>> import plotly.io as pio
>>> list(pio.templates)  
['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]

  • A string containing multiple registered template names, joined on ‘+’ characters (e.g. ‘template1+template2’). In this case the resulting template is computed by merging together the collection of registered templates

Returns

Return type

plotly.graph_objects.layout.Template

property ternary

The ‘ternary’ property is an instance of Ternary that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Ternary

property title

The ‘title’ property is an instance of Title that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Title

property transition

Sets transition options used during Plotly.react updates.

The ‘transition’ property is an instance of Transition that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Transition

property treemapcolorway

Sets the default treemap slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendtreemapcolors.

The ‘treemapcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings

Returns

Return type

list

property uirevision

Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions. If uirevision is omitted, or if it is given and it changed from the previous Plotly.react call, the exact new figure is used. If uirevision is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. layout.uirevision attribute serves as the default for uirevision attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set xaxis.uirevision=*time* and yaxis.uirevision=*cost*. Then if only the y data is changed, you can update yaxis.uirevision=*quantity* and the y axis range will reset but the x axis range will retain any user- driven zoom.

The ‘uirevision’ property accepts values of any type

Returns

Return type

Any

property uniformtext

The ‘uniformtext’ property is an instance of Uniformtext that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Uniformtext

property updatemenudefaults

When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus

The ‘updatemenudefaults’ property is an instance of Updatemenu that may be specified as:

Returns

Return type

plotly.graph_objects.layout.Updatemenu

property updatemenus

The ‘updatemenus’ property is a tuple of instances of Updatemenu that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.layout.Updatemenu

  • A list or tuple of dicts of string/value properties that will be passed to the Updatemenu constructor

Returns

Return type

tuple[plotly.graph_objects.layout.Updatemenu]

property violingap

Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property violingroupgap

Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have “width” set.

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

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

Returns

Return type

int|float

property violinmode

Determines how violins at the same location coordinate are displayed on the graph. If “group”, the violins are plotted next to one another centered around the shared location. If “overlay”, the violins are plotted over one another, you might need to set “opacity” to see them multiple violins. Has no effect on traces that have “width” set.

The ‘violinmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘group’, ‘overlay’]

Returns

Return type

Any

property waterfallgap

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

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

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

Returns

Return type

int|float

property waterfallgroupgap

Sets the gap (in plot fraction) between bars of the same location coordinate.

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

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

Returns

Return type

int|float

property waterfallmode

Determines how bars at the same location coordinate are displayed on the graph. With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

The ‘waterfallmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘group’, ‘overlay’]

Returns

Return type

Any

property width

Sets the plot’s width (in px).

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

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

Returns

Return type

int|float

property xaxis

The ‘xaxis’ property is an instance of XAxis that may be specified as:

Returns

Return type

plotly.graph_objects.layout.XAxis

property yaxis

The ‘yaxis’ property is an instance of YAxis that may be specified as:

Returns

Return type

plotly.graph_objects.layout.YAxis