+ +

plotly.graph_objects package¶

Subpackages¶

plotly.graph_objects.area package
- Subpackages
  - plotly.graph_objects.area.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.bar package
- Subpackages
  - plotly.graph_objects.bar.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.bar.marker package
    - Subpackages
      - plotly.graph_objects.bar.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.bar.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.bar.selected package
    - Module contents
    +
  - plotly.graph_objects.bar.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.barpolar package
- Subpackages
  - plotly.graph_objects.barpolar.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.barpolar.marker package
    - Subpackages
      - plotly.graph_objects.barpolar.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.barpolar.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.barpolar.selected package
    - Module contents
    +
  - plotly.graph_objects.barpolar.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.box package
- Subpackages
  - plotly.graph_objects.box.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.box.marker package
    - Module contents
    +
  - plotly.graph_objects.box.selected package
    - Module contents
    +
  - plotly.graph_objects.box.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.candlestick package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.carpet package
- Subpackages
  - plotly.graph_objects.carpet.aaxis package
    - Subpackages
      - plotly.graph_objects.carpet.aaxis.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.carpet.baxis package
    - Subpackages
      - plotly.graph_objects.carpet.baxis.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.choropleth package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.choroplethmapbox package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.cone package
- Subpackages
  - plotly.graph_objects.cone.colorbar package
    - Subpackages
      - plotly.graph_objects.cone.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.cone.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.contour package
- Subpackages
  - plotly.graph_objects.contour.colorbar package
    - Subpackages
      - plotly.graph_objects.contour.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.contour.contours package
    - Module contents
    +
  - plotly.graph_objects.contour.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.contourcarpet package
- Subpackages
  - plotly.graph_objects.contourcarpet.colorbar package
    - Subpackages
      - plotly.graph_objects.contourcarpet.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.contourcarpet.contours package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.densitymapbox package
- Subpackages
  - plotly.graph_objects.densitymapbox.colorbar package
    - Subpackages
      - plotly.graph_objects.densitymapbox.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.densitymapbox.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.funnel package
- Subpackages
  - plotly.graph_objects.funnel.connector package
    - Module contents
    +
  - plotly.graph_objects.funnel.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.funnel.marker package
    - Subpackages
      - plotly.graph_objects.funnel.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.funnel.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.funnelarea package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.heatmap package
- Subpackages
  - plotly.graph_objects.heatmap.colorbar package
    - Subpackages
      - plotly.graph_objects.heatmap.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.heatmap.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.heatmapgl package
- Subpackages
  - plotly.graph_objects.heatmapgl.colorbar package
    - Subpackages
      - plotly.graph_objects.heatmapgl.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.heatmapgl.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.histogram package
- Subpackages
  - plotly.graph_objects.histogram.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.histogram.marker package
    - Subpackages
      - plotly.graph_objects.histogram.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.histogram.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.histogram.selected package
    - Module contents
    +
  - plotly.graph_objects.histogram.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.histogram2d package
- Subpackages
  - plotly.graph_objects.histogram2d.colorbar package
    - Subpackages
      - plotly.graph_objects.histogram2d.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.histogram2d.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.histogram2dcontour package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.image package
- Subpackages
  - plotly.graph_objects.image.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.indicator package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.isosurface package
- Subpackages
  - plotly.graph_objects.isosurface.caps package
    - Module contents
    +
  - plotly.graph_objects.isosurface.colorbar package
    - Subpackages
      - plotly.graph_objects.isosurface.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.isosurface.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.isosurface.slices package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.layout package
- Subpackages
  - plotly.graph_objects.layout.annotation package
    - Subpackages
      - plotly.graph_objects.layout.annotation.hoverlabel package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.coloraxis package
    - Subpackages
      - plotly.graph_objects.layout.coloraxis.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.layout.coloraxis.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.geo package
    - Subpackages
      - plotly.graph_objects.layout.geo.projection package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.grid package
    - Module contents
    +
  - plotly.graph_objects.layout.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.layout.legend package
    - Subpackages
      - plotly.graph_objects.layout.legend.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.mapbox package
    - Subpackages
      - plotly.graph_objects.layout.mapbox.layer package
        +
        Subpackages
        +
        plotly.graph_objects.layout.mapbox.layer.symbol package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.newshape package
    - Module contents
    +
  - plotly.graph_objects.layout.polar package
    - Subpackages
      - plotly.graph_objects.layout.polar.angularaxis package
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.polar.radialaxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.polar.radialaxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.scene package
    - Subpackages
      - plotly.graph_objects.layout.scene.annotation package
        +
        Subpackages
        +
        plotly.graph_objects.layout.scene.annotation.hoverlabel package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.scene.camera package
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.scene.xaxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.scene.xaxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.scene.yaxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.scene.yaxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.scene.zaxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.scene.zaxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.shape package
    - Module contents
    +
  - plotly.graph_objects.layout.slider package
    - Subpackages
      - plotly.graph_objects.layout.slider.currentvalue package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.template package
    - Subpackages
      - plotly.graph_objects.layout.template.data package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.ternary package
    - Subpackages
      - plotly.graph_objects.layout.ternary.aaxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.ternary.aaxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.ternary.baxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.ternary.baxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      - plotly.graph_objects.layout.ternary.caxis package
        +
        Subpackages
        +
        plotly.graph_objects.layout.ternary.caxis.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.layout.title package
    - Module contents
    +
  - plotly.graph_objects.layout.updatemenu package
    - Module contents
    +
  - plotly.graph_objects.layout.xaxis package
    - Subpackages
      +
    - Module contents
    +
  - plotly.graph_objects.layout.yaxis package
    - Subpackages
      - plotly.graph_objects.layout.yaxis.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.mesh3d package
- Subpackages
  - plotly.graph_objects.mesh3d.colorbar package
    - Subpackages
      - plotly.graph_objects.mesh3d.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.mesh3d.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.ohlc package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.parcats package
- Subpackages
  - plotly.graph_objects.parcats.line package
    - Subpackages
      - plotly.graph_objects.parcats.line.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.parcats.line.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.parcoords package
- Subpackages
  - plotly.graph_objects.parcoords.line package
    - Subpackages
      - plotly.graph_objects.parcoords.line.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.parcoords.line.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.pie package
- Subpackages
  - plotly.graph_objects.pie.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.pie.marker package
    - Module contents
    +
  - plotly.graph_objects.pie.title package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.pointcloud package
- Subpackages
  - plotly.graph_objects.pointcloud.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.pointcloud.marker package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.sankey package
- Subpackages
  - plotly.graph_objects.sankey.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.sankey.link package
    - Subpackages
      - plotly.graph_objects.sankey.link.hoverlabel package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.sankey.node package
    - Subpackages
      - plotly.graph_objects.sankey.node.hoverlabel package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.scatter package
- Subpackages
  - plotly.graph_objects.scatter.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.scatter.marker package
    - Subpackages
      - plotly.graph_objects.scatter.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.scatter.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.scatter.selected package
    - Module contents
    +
  - plotly.graph_objects.scatter.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.scatter3d package
- Subpackages
  - plotly.graph_objects.scatter3d.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.scatter3d.line package
    - Subpackages
      - plotly.graph_objects.scatter3d.line.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.scatter3d.line.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.scatter3d.marker package
    - Subpackages
      - plotly.graph_objects.scatter3d.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.scatter3d.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.scatter3d.projection package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.scattercarpet package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.scattergeo package
- Subpackages
  - plotly.graph_objects.scattergeo.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.scattergeo.marker package
    - Subpackages
      - plotly.graph_objects.scattergeo.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.scattergeo.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.scattergeo.selected package
    - Module contents
    +
  - plotly.graph_objects.scattergeo.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.scattergl package
- Subpackages
  - plotly.graph_objects.scattergl.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.scattergl.marker package
    - Subpackages
      - plotly.graph_objects.scattergl.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.scattergl.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.scattergl.selected package
    - Module contents
    +
  - plotly.graph_objects.scattergl.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.scattermapbox package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.scatterpolar package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.scatterpolargl package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.scatterternary package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.splom package
- Subpackages
  - plotly.graph_objects.splom.dimension package
    - Module contents
    +
  - plotly.graph_objects.splom.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.splom.marker package
    - Subpackages
      - plotly.graph_objects.splom.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.splom.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.splom.selected package
    - Module contents
    +
  - plotly.graph_objects.splom.unselected package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.streamtube package
- Subpackages
  - plotly.graph_objects.streamtube.colorbar package
    - Subpackages
      - plotly.graph_objects.streamtube.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.streamtube.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.sunburst package
- Subpackages
  - plotly.graph_objects.sunburst.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.sunburst.marker package
    - Subpackages
      - plotly.graph_objects.sunburst.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.sunburst.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.surface package
- Subpackages
  - plotly.graph_objects.surface.colorbar package
    - Subpackages
      - plotly.graph_objects.surface.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.surface.contours package
    - Subpackages
      +
    - Module contents
    +
  - plotly.graph_objects.surface.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.table package
- Subpackages
  - plotly.graph_objects.table.cells package
    - Module contents
    +
  - plotly.graph_objects.table.header package
    - Module contents
    +
  - plotly.graph_objects.table.hoverlabel package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.treemap package
- Subpackages
  - plotly.graph_objects.treemap.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.treemap.marker package
    - Subpackages
      - plotly.graph_objects.treemap.marker.colorbar package
        +
        Subpackages
        +
        plotly.graph_objects.treemap.marker.colorbar.title package
        +
        Module contents
        +
        +
        +
        +
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.treemap.pathbar package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.violin package
- Subpackages
  +
- Module contents
+
plotly.graph_objects.volume package
- Subpackages
  - plotly.graph_objects.volume.caps package
    - Module contents
    +
  - plotly.graph_objects.volume.colorbar package
    - Subpackages
      - plotly.graph_objects.volume.colorbar.title package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.volume.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.volume.slices package
    - Module contents
    +
  +
- Module contents
+
plotly.graph_objects.waterfall package
- Subpackages
  - plotly.graph_objects.waterfall.connector package
    - Module contents
    +
  - plotly.graph_objects.waterfall.decreasing package
    - Subpackages
      - plotly.graph_objects.waterfall.decreasing.marker package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.waterfall.hoverlabel package
    - Module contents
    +
  - plotly.graph_objects.waterfall.increasing package
    - Subpackages
      - plotly.graph_objects.waterfall.increasing.marker package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  - plotly.graph_objects.waterfall.totals package
    - Subpackages
      - plotly.graph_objects.waterfall.totals.marker package
        +
        Module contents
        +
        +
      +
    - Module contents
    +
  +
- Module contents
+

Submodules¶

plotly.graph_objects.graph_objects module¶

Module contents¶

+class plotly.graph_objects.Waterfall(arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property base¶

Sets where the bar base is drawn (in position axis units).

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
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.waterfall.connecto +r.Line instance or dict with compatible +properties
+
+
mode
Sets the shape of connector lines.
+
+
visible
Determines if connector lines are drawn.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.waterfall.decreasi +ng.Marker instance or dict with compatible +properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.waterfall.increasi +ng.Marker instance or dict with compatible +properties
+
+
+
+
+
+

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

Returns: +
Return type: plotly.graph_objects.waterfall.Insidetextfont
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

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

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

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

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property offsetgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offsetsrc¶

Sets the source reference on Chart Studio Cloud for offset .

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

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property orientation¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property outsidetextfont¶

Sets the font used for text lying outside the bar.

The ‘outsidetextfont’ property is an instance of Outsidetextfont +that may be specified as:

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

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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.

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

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

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property textpositionsrc¶

Sets the source reference on Chart Studio Cloud for +textposition .

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

Returns: +
Return type: str
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property texttemplate¶

Template string used for rendering the information text that +appear on points. Note that this will override textinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. Every attributes that can be +specified per-point (the ones that are arrayOk: true) are +available. variables 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.waterfall.totals.M +arker instance or dict with compatible +properties
+
+
+
+
+
+

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 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 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.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, legendgroup=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, valuesrc=None, visible=None, x=None, xsrc=None, y=None, ysrc=None, z=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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.volume.caps.X +instance or dict with compatible properties
+
+
y
plotly.graph_objects.volume.caps.Y +instance or dict with compatible properties
+
+
z
plotly.graph_objects.volume.caps.Z +instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.volume. +colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.volume.colorbar.tickformatstopdefaults), sets +the default property values to use for elements +of volume.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.volume.colorbar.Ti +tle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +volume.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +volume.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the color of the contour lines.
+
+
show
Sets whether or not dynamic contours are shown +on hover
+
+
width
Sets the width of the contour lines.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

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

+
+
An instance of plotly.graph_objects.volume.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.volume.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the surface. Please note that in the case +of using high opacity values for example a value greater than +or equal to 0.5 on two surfaces (and 0.25 with four surfaces), +an overlay of multiple transparent surfaces may not perfectly +be sorted in depth by the webgl API. This behavior may be +improved in the near future and is subject to change.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.volume.slices.X +instance or dict with compatible properties
+
+
y
plotly.graph_objects.volume.slices.Y +instance or dict with compatible properties
+
+
z
plotly.graph_objects.volume.slices.Z +instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
fill
Sets the fill ratio of the spaceframe +elements. The default fill value is 1 meaning +that they are entirely shaded. Applying a +fill ratio less than one would allow the +creation of openings parallel to the edges.
+
+
show
Displays/hides tetrahedron shapes between +minimum and maximum iso-values. Often useful +when either caps or surfaces are disabled or +filled with values less than 1.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
count
Sets the number of iso-surfaces between minimum +and maximum iso-values. By default this value +is 2 meaning that only minimum and maximum +surfaces would be drawn.
+
+
fill
Sets the fill ratio of the iso-surface. The +default fill value of the surface is 1 meaning +that they are entirely shaded. On the other +hand Applying a fill ratio less than one +would allow the creation of openings parallel +to the edges.
+
+
pattern
Sets the surface pattern of the iso-surface 3-D +sections. The default pattern of the surface is +all meaning that the rest of surface elements +would be shaded. The check options (either 1 or +2) could be used to draw half of the squares on +the surface. Using various combinations of +capital A, B, C, D and E may also be +used to reduce the number of triangles on the +iso-surfaces and creating other patterns of +interest.
+
+
show
Hides/displays surfaces between minimum and +maximum iso-values.
+
+
+
+
+
+

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¶

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 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 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 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 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.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, legendgroup=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
fillcolor
Sets the inner box plot fill color.
+
+
line
plotly.graph_objects.violin.box.Line +instance or dict with compatible properties
+
+
visible
Determines if an miniature box plot is drawn +inside the violins.
+
+
width
Sets the width of the inner box plots relative +to the violins’ width. For example, with 1, the +inner box plots are as wide as the violins.
+
+
+
+
+
+

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

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

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

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

+
+
An instance of plotly.graph_objects.violin.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.violin.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of line bounding the violin(s).
+
+
width
Sets the width (in px) of line bounding the +violin(s).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
line
:class:`plotly.graph_objects.violin.marker.Line +` instance or dict with compatible properties
+
+
opacity
Sets the marker opacity.
+
+
outliercolor
Sets the color of the outlier sample points.
+
+
size
Sets the marker size (in px).
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
color
Sets the mean line color.
+
+
visible
Determines if a line corresponding to the +sample’s mean is shown inside the violins. If +box.visible is turned on, the mean line is +drawn inside the inner box. Otherwise, the mean +line is drawn from one side of the violin to +other.
+
+
width
Sets the mean line width.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.violin.Meanline
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover. For 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 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 makingup 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.violin.selected.Ma +rker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.violin.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.violin.unselected. +Marker instance or dict with compatible +properties
+
+
+
+
+
+

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¶

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¶

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this treemap trace +.
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this treemap trace .
+
+
x
Sets the horizontal domain of this treemap +trace (in plot fraction).
+
+
y
Sets the vertical domain of this treemap trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if colorsis set to a numerical +array. In case colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +colors) or the bounds set in marker.cmin and +marker.cmax Has an effect only if colorsis +set to a numerical array. Defaults to false +when marker.cmin and marker.cmax are set by +the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmin must be set as +well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if colorsis set to a numerical array. +Value should have the same units as colors. Has +no effect when marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmax must be set as +well.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.treemap.marker.Col +orBar instance or dict with compatible +properties
+
+
colors
Sets the color of each sector of this trace. If +not specified, the default trace color set is +used to pick the sector colors.
+
+
colorscale
Sets the colorscale. Has an effect only if +colorsis set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
depthfade
Determines if the sector colors are faded +towards the background from the leaves up to +the headers. This option is unavailable when a +colorscale is present, defaults to false when +marker.colors is set, but otherwise defaults +to true. When set to “reversed”, the fading +direction is inverted, that is the top elements +within hierarchy are drawn with fully saturated +colors while the leaves are faded towards the +background color.
+
+
line
plotly.graph_objects.treemap.marker.Lin +e instance or dict with compatible properties
+
+
pad
:class:`plotly.graph_objects.treemap.marker.Pad +` instance or dict with compatible properties
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if colorsis set to a numerical +array. If true, marker.cmin will correspond +to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +colorsis set to a numerical array.
+
+
+
+
+
+

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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

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

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
edgeshape
Determines which shape is used for edges +between barpath labels.
+
+
side
Determines on which side of the the treemap the +pathbar should be presented.
+
+
textfont
Sets the font used inside pathbar.
+
+
thickness
Sets the thickness of pathbar (in px). If not +specified the pathbar.textfont.size is used +with 3 pixles extra padding on each side.
+
+
visible
Determines if the path bar is drawn i.e. +outside the trace domain and with one pixel +gap.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.treemap.Pathbar
+

+ +

+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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
flip
Determines if the positions obtained from +solver are flipped on each axis.
+
+
packing
Determines d3 treemap solver. For more info +please refer to +https://github.com/d3/d3-hierarchy#treemap- +tiling
+
+
pad
Sets the inner padding (in px).
+
+
squarifyratio
When using “squarify” packing algorithm, +according to https://github.com/d3/d3-hierarchy +/blob/master/README.md#squarify_ratio this +option specifies the desired aspect ratio of +the generated rectangles. The ratio must be +specified as a number greater than or equal to +one. Note that the orientation of the generated +rectangles (tall or wide) is not implied by the +ratio; for example, a ratio of two will attempt +to produce a mixture of rectangles whose +width:height ratio is either 2:1 or 1:2. When +using “squarify”, unlike d3 which uses the +Golden Ratio i.e. 1.618034, Plotly applies 1 to +increase squares in treemap layouts.
+
+
+
+
+
+

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¶

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.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, 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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +within the box. Has an effect only if text +spans two or more lines (i.e. text contains +one or more HTML tags) or if an explicit +width is set to override the text width.
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
fill
plotly.graph_objects.table.cells.Fill +instance or dict with compatible properties
+
+
font
plotly.graph_objects.table.cells.Font +instance or dict with compatible properties
+
+
format
Sets the cell value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
formatsrc
Sets the source reference on Chart Studio Cloud +for format .
+
+
height
The height of cells.
+
+
line
plotly.graph_objects.table.cells.Line +instance or dict with compatible properties
+
+
prefix
Prefix for cell values.
+
+
prefixsrc
Sets the source reference on Chart Studio Cloud +for prefix .
+
+
suffix
Suffix for cell values.
+
+
suffixsrc
Sets the source reference on Chart Studio Cloud +for suffix .
+
+
values
Cell values. values[m][n] represents the +value of the n`th point in column `m, +therefore the values[m] vector length for all +columns must be the same (longer vectors will +be truncated). Each value must be a finite +number or a string.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this table trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this table trace .
+
+
x
Sets the horizontal domain of this table trace +(in plot fraction).
+
+
y
Sets the vertical domain of this table trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +within the box. Has an effect only if text +spans two or more lines (i.e. text contains +one or more HTML tags) or if an explicit +width is set to override the text width.
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
fill
plotly.graph_objects.table.header.Fill +instance or dict with compatible properties
+
+
font
plotly.graph_objects.table.header.Font +instance or dict with compatible properties
+
+
format
Sets the cell value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
formatsrc
Sets the source reference on Chart Studio Cloud +for format .
+
+
height
The height of cells.
+
+
line
plotly.graph_objects.table.header.Line +instance or dict with compatible properties
+
+
prefix
Prefix for cell values.
+
+
prefixsrc
Sets the source reference on Chart Studio Cloud +for prefix .
+
+
suffix
Suffix for cell values.
+
+
suffixsrc
Sets the source reference on Chart Studio Cloud +for suffix .
+
+
values
Header cell values. values[m][n] represents +the value of the n`th point in column `m, +therefore the values[m] vector length for all +columns must be the same (longer vectors will +be truncated). Each value must be a finite +number or a string.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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.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, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property 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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.surface +.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.surface.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of surface.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.surface.colorbar.T +itle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +surface.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +surface.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.surface.ColorBar
+

+ +

+property colorscale¶

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property connectgaps¶

Determines whether or not gaps (i.e. {nan} or missing values) +in the z data are filled in.

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
+
Supported dict properties:
+
+
+
x
:class:`plotly.graph_objects.surface.contours.X +` instance or dict with compatible properties
+
+
y
:class:`plotly.graph_objects.surface.contours.Y +` instance or dict with compatible properties
+
+
z
:class:`plotly.graph_objects.surface.contours.Z +` instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

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

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.surface.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

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

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

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

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.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, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=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¶

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this sunburst trace +.
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this sunburst trace .
+
+
x
Sets the horizontal domain of this sunburst +trace (in plot fraction).
+
+
y
Sets the vertical domain of this sunburst trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
opacity
Sets the opacity of the leaves. With colorscale +it is defaulted to 1; otherwise it is defaulted +to 0.7
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sunburst.Leaf
+

+ +

+property level¶

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if colorsis set to a numerical +array. In case colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +colors) or the bounds set in marker.cmin and +marker.cmax Has an effect only if colorsis +set to a numerical array. Defaults to false +when marker.cmin and marker.cmax are set by +the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmin must be set as +well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if colorsis set to a numerical array. +Value should have the same units as colors. Has +no effect when marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmax must be set as +well.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.sunburst.marker.Co +lorBar instance or dict with compatible +properties
+
+
colors
Sets the color of each sector of this trace. If +not specified, the default trace color set is +used to pick the sector colors.
+
+
colorscale
Sets the colorscale. Has an effect only if +colorsis set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
line
plotly.graph_objects.sunburst.marker.Li +ne instance or dict with compatible properties
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if colorsis set to a numerical +array. If true, marker.cmin will correspond +to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +colorsis set to a numerical array.
+
+
+
+
+
+

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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

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

Returns: +
Return type: plotly.graph_objects.sunburst.Outsidetextfont
+

+ +

+property parents¶

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 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sunburst.Stream
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property cauto¶

Determines whether or not the color domain is computed with +respect to the input data (here u/v/w norm) or the bounds set +in cmin and cmax Defaults to false when cmin and +cmax are set by the user.

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

Returns: +
Return type: bool
+

+ +

+property cmax¶

Sets the upper bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmin must be set as +well.

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmid¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmin¶

Sets the lower bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmax must be set as +well.

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.streamtube.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.streamt +ube.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.streamtube.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of streamtube.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.streamtube.colorba +r.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +streamtube.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +streamtube.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.streamtube.ColorBar
+

+ +

+property colorscale¶

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

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

+
+
An instance of plotly.graph_objects.streamtube.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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
+
Supported dict properties:
+
+
+
x
Sets the x components of the starting position +of the streamtubes
+
+
xsrc
Sets the source reference on Chart Studio Cloud +for x .
+
+
y
Sets the y components of the starting position +of the streamtubes
+
+
ysrc
Sets the source reference on Chart Studio Cloud +for y .
+
+
z
Sets the z components of the starting position +of the streamtubes
+
+
zsrc
Sets the source reference on Chart Studio Cloud +for z .
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property usrc¶

Sets the source reference on Chart Studio Cloud for u .

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

Returns: +
Return type: str
+

+ +

+property v¶

Sets the y components of the vector field.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property vsrc¶

Sets the source reference on Chart Studio Cloud for v .

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

Returns: +
Return type: str
+

+ +

+property w¶

Sets the z components of the vector field.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property wsrc¶

Sets the source reference on Chart Studio Cloud for w .

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

Returns: +
Return type: str
+

+ +

+property x¶

Sets the x coordinates of the vector field.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates of the vector field.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property z¶

Sets the z coordinates of the vector field.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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, yaxes=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
+
Supported dict properties:
+
+
+
visible
Determines whether or not subplots on the +diagonal are displayed.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
axis
plotly.graph_objects.splom.dimension.Ax +is instance or dict with compatible properties
+
+
label
Sets the label corresponding to this splom +dimension.
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
values
Sets the dimension values to be plotted.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
visible
Determines whether or not this dimension is +shown on the graph. Note that even visible +false dimension contribute to the default grid +generate by this splom trace.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

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

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.splom.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.splom.marker.Color +Bar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.splom.marker.Line +instance or dict with compatible properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.splom.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.splom.selected.Mar +ker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.splom.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.splom.unselected.M +arker instance or dict with compatible +properties
+
+
+
+
+
+

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

+ +

+class plotly.graph_objects.Scatterternary(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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¶

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¶

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.scatterternary.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatterternary.mar +ker.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scatterternary.mar +ker.Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scatterternary.mar +ker.Line instance or dict with compatible +properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterternary.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterternary.sel +ected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterternary.sel +ected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterternary.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scatterternary.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterternary.uns +elected.Marker instance or dict with +compatible properties
+
+
textfont
plotly.graph_objects.scatterternary.uns +elected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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.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, legendgroup=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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the style of the lines.
+
+
shape
Determines the line shape. The values +correspond to step-wise line shapes.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatterpolargl.mar +ker.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.scatterpolargl.mar +ker.Line instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolargl.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property r¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolargl.sel +ected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterpolargl.sel +ected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolargl.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scatterpolargl.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolargl.uns +elected.Marker instance or dict with +compatible properties
+
+
textfont
plotly.graph_objects.scatterpolargl.uns +elected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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.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, legendgroup=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¶

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatterpolar.marke +r.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scatterpolar.marke +r.Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scatterpolar.marke +r.Line instance or dict with compatible +properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property r¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolar.selec +ted.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterpolar.selec +ted.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scatterpolar.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolar.unsel +ected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterpolar.unsel +ected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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.Scattermapbox(arg=None, below=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, legendgroup=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 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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

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

Returns: +
Return type: str
+

+ +

+property hovertext¶

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

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property lat¶

Sets the latitude coordinates (in degrees North).

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property latsrc¶

Sets the source reference on Chart Studio Cloud for lat .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattermapbox.mark +er.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol. Full list: +https://www.mapbox.com/maki-icons/ Note that +the array marker.color and marker.size are +only available for “circle” symbols.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattermapbox.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattermapbox.sele +cted.Marker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattermapbox.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scattermapbox.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattermapbox.Stream
+

+ +

+property subplot¶

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

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

Returns: +
Return type: str
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattermapbox.unse +lected.Marker instance or dict with compatible +properties
+
+
+
+
+
+

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.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, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.ErrorY
+

+ +

+property fill¶

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

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

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

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

+
+
An instance of plotly.graph_objects.scattergl.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the style of the lines.
+
+
shape
Determines the line shape. The values +correspond to step-wise line shapes.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattergl.marker.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.scattergl.marker.L +ine instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergl.selected +.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergl.selected +.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scattergl.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.Stream
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergl.unselect +ed.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergl.unselect +ed.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

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

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

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

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

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

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

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

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.scattergeo.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Line
+

+ +

+property locationmode¶

Determines the set of locations used to match entries in +locations to regions on the map. Values “ISO-3”, “USA- +states”, country names correspond to features on the base map +and value “geojson-id” corresponds to features from a custom +GeoJSON linked to the geojson attribute.

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

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

Returns: +
Return type: Any
+

+ +

+property locations¶

Sets the coordinates via location IDs or names. 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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattergeo.marker. +ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scattergeo.marker. +Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scattergeo.marker. +Line instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergeo.selecte +d.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergeo.selecte +d.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scattergeo.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergeo.unselec +ted.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergeo.unselec +ted.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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.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, legendgroup=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, **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¶

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.scattercarpet.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattercarpet.mark +er.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scattercarpet.mark +er.Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scattercarpet.mark +er.Line instance or dict with compatible +properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattercarpet.sele +cted.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattercarpet.sele +cted.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.scattercarpet.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattercarpet.unse +lected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattercarpet.unse +lected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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¶

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Scatter3d(arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_zstyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_zstyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.scatter3d.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by line.colorscale. Has an effect +only if in line.color`is set to a numerical +array. In case `colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in line.color) or the bounds set in +line.cmin and line.cmax Has an effect only +if in line.color`is set to a numerical array. +Defaults to `false when line.cmin and +line.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling line.cmin and/or line.cmax to be +equidistant to this point. Has an effect only +if in line.color`is set to a numerical array. +Value should have the same units as in +`line.color. Has no effect when line.cauto +is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmax must be set as well.
+
+
color
Sets thelinecolor. It accepts either a specific +color or an array of numbers that are mapped to +the colorscale relative to the max and min +values of the array or relative to line.cmin +and line.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatter3d.line.Col +orBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +line.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`line.cmin` and line.cmax. +Alternatively, colorscale may be a palette +name string of the following list: Greys,YlGnBu +,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R +ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri +c,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
dash
Sets the dash style of the lines.
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in line.color`is set to a +numerical array. If true, `line.cmin will +correspond to the last color in the array and +line.cmax will correspond to the first color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `line.color`is set to a numerical array.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatter3d.marker.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.scatter3d.marker.L +ine instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity. Note that the marker +opacity for scatter3d traces must be a scalar +value for performance reasons. To set a +blending opacity value (i.e. which is not +transparent), set “marker.color” to an rgba +color and use its alpha channel.
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter3d.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.scatter3d.projecti +on.X instance or dict with compatible +properties
+
+
y
plotly.graph_objects.scatter3d.projecti +on.Y instance or dict with compatible +properties
+
+
z
plotly.graph_objects.scatter3d.projecti +on.Z instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter3d.Projection
+

+ +

+property scene¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property 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¶

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

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¶

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¶

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

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

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

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

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.Scatter(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, orientation=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, t=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property cliponaxis¶

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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.ErrorY
+

+ +

+property fill¶

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

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
simplify
Simplifies lines by removing nearly-collinear +points. When transitioning lines, it may be +desirable to disable this so that the number of +points along the resulting SVG path is +unaffected.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatter.marker.Col +orBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scatter.marker.Gra +dient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scatter.marker.Lin +e instance or dict with compatible properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property orientation¶

Only relevant 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
+

+ +

+property r¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

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

Returns: +
Return type: str
+

+ +

+property selected¶

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

+
+
An instance of plotly.graph_objects.scatter.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatter.selected.M +arker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatter.selected.T +extfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Stream
+

+ +

+property t¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for +texttemplate .

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

Returns: +
Return type: str
+

+ +

+property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

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

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

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

+
+
An instance of plotly.graph_objects.scatter.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatter.unselected +.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatter.unselected +.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

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

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

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

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

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

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

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

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Sankey(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this sankey trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this sankey trace .
+
+
x
Sets the horizontal domain of this sankey trace +(in plot fraction).
+
+
y
Sets the vertical domain of this sankey trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 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
+
Supported dict properties:
+
+
+
color
Sets the link color. It can be a single +value, or an array for specifying color for +each link. If link.color is omitted, then +by default, a translucent grey link will be +used.
+
+
colorscales
A tuple of plotly.graph_objects.sankey. +link.Colorscale instances or dicts with +compatible properties
+
+
colorscaledefaults
When used in a template (as layout.template.dat +a.sankey.link.colorscaledefaults), sets the +default property values to use for elements of +sankey.link.colorscales
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
customdata
Assigns extra data to each link.
+
+
customdatasrc
Sets the source reference on Chart Studio Cloud +for customdata .
+
+
hoverinfo
Determines which trace information appear when +hovering links. If none or skip are set, no +information is displayed upon hovering. But, if +none is set, click and hover events are still +fired.
+
+
hoverlabel
plotly.graph_objects.sankey.link.Hoverl +abel instance or dict with compatible +properties
+
+
hovertemplate
Template string used for rendering the +information that appear on hover box. Note that +this will override hoverinfo. Variables are +inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s +syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +for details on the formatting syntax. Dates are +formatted using d3-time-format’s syntax +%{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +for details on the date formatting syntax. The +variables available in hovertemplate are the +ones emitted as event data described at this +link https://plotly.com/javascript/plotlyjs- +events/#event-data. Additionally, every +attributes that can be specified per-point (the +ones that are arrayOk: true) are available. +variables value and label. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
+
+
hovertemplatesrc
Sets the source reference on Chart Studio Cloud +for hovertemplate .
+
+
label
The shown name of the link.
+
+
labelsrc
Sets the source reference on Chart Studio Cloud +for label .
+
+
line
plotly.graph_objects.sankey.link.Line +instance or dict with compatible properties
+
+
source
An integer number [0..nodes.length - 1] that +represents the source node.
+
+
sourcesrc
Sets the source reference on Chart Studio Cloud +for source .
+
+
target
An integer number [0..nodes.length - 1] that +represents the target node.
+
+
targetsrc
Sets the source reference on Chart Studio Cloud +for target .
+
+
value
A numeric value representing the flow volume +value.
+
+
valuesrc
Sets the source reference on Chart Studio Cloud +for value .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sankey.Link
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the node color. It can be a single +value, or an array for specifying color for +each node. If node.color is omitted, then +the default Plotly color palette will be +cycled through to have a variety of colors. +These defaults are not fully opaque, to allow +some visibility of what is beneath the node.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
customdata
Assigns extra data to each node.
+
+
customdatasrc
Sets the source reference on Chart Studio Cloud +for customdata .
+
+
groups
Groups of nodes. Each group is defined by an +array with the indices of the nodes it +contains. Multiple groups can be specified.
+
+
hoverinfo
Determines which trace information appear when +hovering nodes. If none or skip are set, no +information is displayed upon hovering. But, if +none is set, click and hover events are still +fired.
+
+
hoverlabel
plotly.graph_objects.sankey.node.Hoverl +abel instance or dict with compatible +properties
+
+
hovertemplate
Template string used for rendering the +information that appear on hover box. Note that +this will override hoverinfo. Variables are +inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s +syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +for details on the formatting syntax. Dates are +formatted using d3-time-format’s syntax +%{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +for details on the date formatting syntax. The +variables available in hovertemplate are the +ones emitted as event data described at this +link https://plotly.com/javascript/plotlyjs- +events/#event-data. Additionally, every +attributes that can be specified per-point (the +ones that are arrayOk: true) are available. +variables value and label. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
+
+
hovertemplatesrc
Sets the source reference on Chart Studio Cloud +for hovertemplate .
+
+
label
The shown name of the node.
+
+
labelsrc
Sets the source reference on Chart Studio Cloud +for label .
+
+
line
plotly.graph_objects.sankey.node.Line +instance or dict with compatible properties
+
+
pad
Sets the padding (in px) between the nodes.
+
+
thickness
Sets the thickness (in px) of the nodes.
+
+
x
The normalized horizontal position of the node.
+
+
xsrc
Sets the source reference on Chart Studio Cloud +for x .
+
+
y
The normalized vertical position of the node.
+
+
ysrc
Sets the source reference on Chart Studio Cloud +for y .
+
+
+
+
+
+

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

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

Returns: +
Return type: plotly.graph_objects.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¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property valueformat¶

Sets the value formatting rule using d3 formatting mini- +language which is similar to those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#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.Pointcloud(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

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

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

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

+
+
An instance of plotly.graph_objects.pointcloud.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pointcloud.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 indices¶

A sequential value, 0..n, supply it to avoid creating this +array inside plotting. If specified, it must be a typed +Int32Array array. Its length must be equal to or greater than +the number of points. For the best performance and memory use, +create one large indices typed array that is guaranteed to be +at least as long as the largest number of points during use, +and reuse it on each Plotly.restyle() call.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property indicessrc¶

Sets the source reference on Chart Studio Cloud for indices .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.pointcloud.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
blend
Determines if colors are blended together for a +translucency effect in case opacity is +specified as a value less then 1. Setting +blend to true reduces zoom/pan speed if +used with large numbers of points.
+
+
border
plotly.graph_objects.pointcloud.marker. +Border instance or dict with compatible +properties
+
+
color
Sets the marker fill color. It accepts a +specific color.If the color is not fully opaque +and there are hundreds of thousandsof points, +it may cause slower zooming and panning.
+
+
opacity
Sets the marker opacity. The default value is +1 (fully opaque). If the markers are not +fully opaque and there are hundreds of +thousands of points, it may cause slower +zooming and panning. Opacity fades the color +even if blend is left on false even if +there is no translucency effect in that case.
+
+
sizemax
Sets the maximum size (in px) of the rendered +marker points. Effective when the pointcloud +shows only few points.
+
+
sizemin
Sets the minimum size (in px) of the rendered +marker points, effective when the pointcloud +shows a million or more points.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pointcloud.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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 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.pointcloud.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pointcloud.Stream
+

+ +

+property text¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property 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 xaxis¶

Returns: +
Return type: str
+

+ +

+property xbounds¶

Specify xbounds in the shape of [xMin, xMax] to avoid +looping through the `xy typed array. Use it in conjunction +with xy and ybounds for the performance benefits.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property xboundssrc¶

Sets the source reference on Chart Studio Cloud for xbounds .

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

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

Faster alternative to specifying x and y separately. If +supplied, it must be a typed Float32Array array that +represents points such that xy[i * 2] = x[i] and xy[i * 2 + +1] = y[i]

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property xysrc¶

Sets the source reference on Chart Studio Cloud for xy .

The ‘xysrc’ 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 yaxis¶

Returns: +
Return type: str
+

+ +

+property ybounds¶

Specify ybounds in the shape of [yMin, yMax] to avoid +looping through the `xy typed array. Use it in conjunction +with xy and xbounds for the performance benefits.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property yboundssrc¶

Sets the source reference on Chart Studio Cloud for ybounds .

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

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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, titlefont=None, titleposition=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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this pie trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this pie trace .
+
+
x
Sets the horizontal domain of this pie trace +(in plot fraction).
+
+
y
Sets the vertical domain of this pie trace (in +plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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

Returns: +
Return type: plotly.graph_objects.pie.Insidetextfont
+

+ +

+property insidetextorientation¶

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

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.pie.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
colors
Sets the color of each sector. If not +specified, the default trace color set is used +to pick the sector colors.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
line
plotly.graph_objects.pie.marker.Line +instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

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

Returns: +
Return type: plotly.graph_objects.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 number and may be specified as:

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

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Stream
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
font
Sets the font used for title. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
position
Specifies the location of the title. Note +that the title’s position used to be set by the +now deprecated titleposition attribute.
+
+
text
Sets the title of the chart. If it is empty, no +title is displayed. Note that before the +existence of title.text, the title’s contents +used to be defined as the title attribute +itself. This behavior has been deprecated.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Title
+

+ +

+property titlefont¶

Please use pie.title.font instead. Sets the font +used for title. Note that the title’s font used to be set by +the now deprecated titlefont attribute.

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

+
+
An instance of plotly.graph_objects.pie.title.Font
+
A dict of string/value properties that will be passed +to the Font constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Type: Deprecated
+

+ +

+property titleposition¶

Please use pie.title.position instead. Specifies +the location of the title. Note that the title’s position +used to be set by the now deprecated titleposition attribute.

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

+
One of the following enumeration values:
[‘top left’, ‘top center’, ‘top right’, ‘middle center’, +‘bottom left’, ‘bottom center’, ‘bottom right’]
+
+
+

Type: Deprecated
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property 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.Parcoords(arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
constraintrange
The domain range to which the filter on the +dimension is constrained. Must be an array of +[fromValue, toValue] with fromValue <= +toValue, or if multiselect is not disabled, +you may give an array of arrays, where each +inner array is [fromValue, toValue].
+
+
label
The shown name of the dimension.
+
+
multiselect
Do we allow multiple selection ranges or just a +single range?
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
range
The domain range that represents the full, +shown axis extent. Defaults to the values +extent. Must be an array of [fromValue, +toValue] with finite numbers as elements.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
values
Dimension values. values[n] represents the +value of the n`th point in the dataset, +therefore the `values vector for all +dimensions must be the same (longer vectors +will be truncated). Each value must be a finite +number.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
visible
Shows the dimension when set to true (the +default). Hides the dimension for false.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this parcoords +trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this parcoords trace .
+
+
x
Sets the horizontal domain of this parcoords +trace (in plot fraction).
+
+
y
Sets the vertical domain of this parcoords +trace (in plot fraction).
+
+
+
+
+
+

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

Returns: +
Return type: plotly.graph_objects.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 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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by line.colorscale. Has an effect +only if in line.color`is set to a numerical +array. In case `colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in line.color) or the bounds set in +line.cmin and line.cmax Has an effect only +if in line.color`is set to a numerical array. +Defaults to `false when line.cmin and +line.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling line.cmin and/or line.cmax to be +equidistant to this point. Has an effect only +if in line.color`is set to a numerical array. +Value should have the same units as in +`line.color. Has no effect when line.cauto +is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmax must be set as well.
+
+
color
Sets thelinecolor. It accepts either a specific +color or an array of numbers that are mapped to +the colorscale relative to the max and min +values of the array or relative to line.cmin +and line.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.parcoords.line.Col +orBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +line.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`line.cmin` and line.cmax. +Alternatively, colorscale may be a palette +name string of the following list: Greys,YlGnBu +,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R +ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri +c,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in line.color`is set to a +numerical array. If true, `line.cmin will +correspond to the last color in the array and +line.cmax will correspond to the first color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `line.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcoords.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

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

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

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

Returns: +
Return type: plotly.graph_objects.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¶

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.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, 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
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
categoryarray
Sets the order in which categories in this +dimension appear. Only has an effect if +categoryorder is set to “array”. Used with +categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the categories +in the dimension. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray.
+
+
displayindex
The display index of dimension, from left to +right, zero indexed, defaults to dimension +index.
+
+
label
The shown name of the dimension.
+
+
ticktext
Sets alternative tick labels for the categories +in this dimension. Only has an effect if +categoryorder is set to “array”. Should be an +array the same length as categoryarray Used +with categoryorder.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
values
Dimension values. values[n] represents the +category value of the n`th point in the +dataset, therefore the `values vector for all +dimensions must be the same (longer vectors +will be truncated).
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
visible
Shows the dimension when set to true (the +default). Hides the dimension for false.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this parcats trace +.
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this parcats trace .
+
+
x
Sets the horizontal domain of this parcats +trace (in plot fraction).
+
+
y
Sets the vertical domain of this parcats trace +(in plot fraction).
+
+
+
+
+
+

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcats.Labelfont
+

+ +

+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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by line.colorscale. Has an effect +only if in line.color`is set to a numerical +array. In case `colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in line.color) or the bounds set in +line.cmin and line.cmax Has an effect only +if in line.color`is set to a numerical array. +Defaults to `false when line.cmin and +line.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling line.cmin and/or line.cmax to be +equidistant to this point. Has an effect only +if in line.color`is set to a numerical array. +Value should have the same units as in +`line.color. Has no effect when line.cauto +is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmax must be set as well.
+
+
color
Sets thelinecolor. It accepts either a specific +color or an array of numbers that are mapped to +the colorscale relative to the max and min +values of the array or relative to line.cmin +and line.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.parcats.line.Color +Bar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +line.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`line.cmin` and line.cmax. +Alternatively, colorscale may be a palette +name string of the following list: Greys,YlGnBu +,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R +ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri +c,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
hovertemplate
Template string used for rendering the +information that appear on hover box. Note that +this will override hoverinfo. Variables are +inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s +syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +for details on the formatting syntax. Dates are +formatted using d3-time-format’s syntax +%{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +for details on the date formatting syntax. The +variables available in hovertemplate are the +ones emitted as event data described at this +link https://plotly.com/javascript/plotlyjs- +events/#event-data. Additionally, every +attributes that can be specified per-point (the +ones that are arrayOk: true) are available. +variables count and probability. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in line.color`is set to a +numerical array. If true, `line.cmin will +correspond to the last color in the array and +line.cmax will correspond to the first color.
+
+
shape
Sets the shape of the paths. If linear, paths +are composed of straight lines. If hspline, +paths are composed of horizontal curved splines
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `line.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcats.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

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

Returns: +
Return type: plotly.graph_objects.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¶

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.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, legendgroup=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property close¶

Sets the close values.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property closesrc¶

Sets the source reference on Chart Studio Cloud for close .

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

Returns: +
Return type: str
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property decreasing¶

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

+
+
An instance of plotly.graph_objects.ohlc.Decreasing
+
A dict of string/value properties that will be passed +to the Decreasing constructor
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.ohlc.decreasing.Li +ne instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
split
Show hover information (open, close, high, low) +in separate labels.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.ohlc.increasing.Li +ne instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.ohlc.Increasing
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.ohlc.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”). +Note that this style setting can also be set +per direction via increasing.line.dash and +decreasing.line.dash.
+
+
width
[object Object] Note that this style setting +can also be set per direction via +increasing.line.width and +decreasing.line.width.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property open¶

Sets the open values.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property opensrc¶

Sets the source reference on Chart Studio Cloud for open .

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

Returns: +
Return type: str
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.ohlc.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

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

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

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=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¶

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

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.mesh3d.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.mesh3d. +colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.mesh3d.colorbar.tickformatstopdefaults), sets +the default property values to use for elements +of mesh3d.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.mesh3d.colorbar.Ti +tle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +mesh3d.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +mesh3d.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.mesh3d.ColorBar
+

+ +

+property colorscale¶

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the color of the contour lines.
+
+
show
Sets whether or not dynamic contours are shown +on hover
+
+
width
Sets the width of the contour lines.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

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

+
+
An instance of plotly.graph_objects.mesh3d.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.mesh3d.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the Y coordinates 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

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.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, legendgroup=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, valuesrc=None, visible=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.isosurface.caps.X +instance or dict with compatible properties
+
+
y
plotly.graph_objects.isosurface.caps.Y +instance or dict with compatible properties
+
+
z
plotly.graph_objects.isosurface.caps.Z +instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.isosurface.Caps
+

+ +

+property cauto¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.isosurf +ace.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.isosurface.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of isosurface.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.isosurface.colorba +r.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +isosurface.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +isosurface.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.isosurface.ColorBar
+

+ +

+property colorscale¶

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the color of the contour lines.
+
+
show
Sets whether or not dynamic contours are shown +on hover
+
+
width
Sets the width of the contour lines.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

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

+
+
An instance of plotly.graph_objects.isosurface.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.isosurface.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.isosurface.slices. +X instance or dict with compatible properties
+
+
y
plotly.graph_objects.isosurface.slices. +Y instance or dict with compatible properties
+
+
z
plotly.graph_objects.isosurface.slices. +Z instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
fill
Sets the fill ratio of the spaceframe +elements. The default fill value is 0.15 +meaning that only 15% of the area of every +faces of tetras would be shaded. Applying a +greater fill ratio would allow the creation +of stronger elements or could be sued to have +entirely closed areas (in case of using 1).
+
+
show
Displays/hides tetrahedron shapes between +minimum and maximum iso-values. Often useful +when either caps or surfaces are disabled or +filled with values less than 1.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
count
Sets the number of iso-surfaces between minimum +and maximum iso-values. By default this value +is 2 meaning that only minimum and maximum +surfaces would be drawn.
+
+
fill
Sets the fill ratio of the iso-surface. The +default fill value of the surface is 1 meaning +that they are entirely shaded. On the other +hand Applying a fill ratio less than one +would allow the creation of openings parallel +to the edges.
+
+
pattern
Sets the surface pattern of the iso-surface 3-D +sections. The default pattern of the surface is +all meaning that the rest of surface elements +would be shaded. The check options (either 1 or +2) could be used to draw half of the squares on +the surface. Using various combinations of +capital A, B, C, D and E may also be +used to reduce the number of triangles on the +iso-surfaces and creating other patterns of +interest.
+
+
show
Hides/displays surfaces between minimum and +maximum iso-values.
+
+
+
+
+
+

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¶

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

Sets the source reference on Chart Studio Cloud for z .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Indicator(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, 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
+
Supported dict properties:
+
+
+
decreasing
plotly.graph_objects.indicator.delta.De +creasing instance or dict with compatible +properties
+
+
font
Set the font used to display the delta
+
+
increasing
plotly.graph_objects.indicator.delta.In +creasing instance or dict with compatible +properties
+
+
position
Sets the position of delta with respect to the +number.
+
+
reference
Sets the reference value to compute the delta. +By default, it is set to the current value.
+
+
relative
Show relative change
+
+
valueformat
Sets the value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this indicator +trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this indicator trace .
+
+
x
Sets the horizontal domain of this indicator +trace (in plot fraction).
+
+
y
Sets the vertical domain of this indicator +trace (in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
axis
plotly.graph_objects.indicator.gauge.Ax +is instance or dict with compatible properties
+
+
bar
Set the appearance of the gauge’s value
+
+
bgcolor
Sets the gauge background color.
+
+
bordercolor
Sets the color of the border enclosing the +gauge.
+
+
borderwidth
Sets the width (in px) of the border enclosing +the gauge.
+
+
shape
Set the shape of the gauge
+
+
steps
A tuple of plotly.graph_objects.indicat +or.gauge.Step instances or dicts with +compatible properties
+
+
stepdefaults
When used in a template (as layout.template.dat +a.indicator.gauge.stepdefaults), sets the +default property values to use for elements of +indicator.gauge.steps
+
+
threshold
plotly.graph_objects.indicator.gauge.Th +reshold instance or dict with compatible +properties
+
+
+
+
+
+

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

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
font
Set the font used to display main number
+
+
prefix
Sets a prefix appearing before the number.
+
+
suffix
Sets a suffix appearing next to the number.
+
+
valueformat
Sets the value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the title. It +defaults to center except for bullet charts +for which it defaults to right.
+
+
font
Set the font used to display the title
+
+
text
Sets the title of this indicator.
+
+
+
+
+
+

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¶

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.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, meta=None, metasrc=None, name=None, opacity=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, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property colormodel¶

Color model used to map the numerical color components +described in z into colors.

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

+
One of the following enumeration values:
[‘rgb’, ‘rgba’, ‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.image.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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 ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property y0¶

Set the image’s y position.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

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

Sets the source reference on Chart Studio Cloud for z .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Histogram2dContour(arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legendgroup=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, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=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¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.histogr +am2dcontour.colorbar.Tickformatstop instances +or dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.histogram2dcontour.colorbar.tickformatstopdef +aults), sets the default property values to use +for elements of +histogram2dcontour.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.histogram2dcontour +.colorbar.Title instance or dict with +compatible properties
+
+
titlefont
Deprecated: Please use +histogram2dcontour.colorbar.title.font instead. +Sets this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +histogram2dcontour.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
coloring
Determines the coloring method showing the +contour values. If “fill”, coloring is done +evenly between each contour level If “heatmap”, +a heatmap gradient coloring is applied between +each contour level. If “lines”, coloring is +done on the contour lines. If “none”, no +coloring is applied on this trace.
+
+
end
Sets the end contour level value. Must be more +than contours.start
+
+
labelfont
Sets the font used for labeling the contour +levels. The default color comes from the lines, +if shown. The default family and size come from +layout.font.
+
+
labelformat
Sets the contour label formatting rule using d3 +formatting mini-language which is very similar +to Python, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
operation
Sets the constraint operation. “=” keeps +regions equal to value “<” and “<=” keep +regions less than value “>” and “>=” keep +regions greater than value “[]”, “()”, “[)”, +and “(]” keep regions inside value[0] to +value[1] “][“, “)(“, “](“, “)[” keep regions +outside value[0] to value[1]` Open vs. closed +intervals make no difference to constraint +display, but all versions are allowed for +consistency with filter transforms.
+
+
showlabels
Determines whether to label the contour lines +with their values.
+
+
showlines
Determines whether or not the contour lines are +drawn. Has an effect only if +contours.coloring is set to “fill”.
+
+
size
Sets the step between each contour level. Must +be positive.
+
+
start
Sets the starting contour level value. Must be +less than contours.end
+
+
type
If levels, the data is represented as a +contour plot with multiple levels displayed. If +constraint, the data is represented as +constraints with the invalid region shaded as +specified by the operation and value +parameters.
+
+
value
Sets the value or values of the constraint +boundary. When operation is set to one of the +comparison values (=,<,>=,>,<=) “value” is +expected to be a number. When operation is +set to one of the interval values +([],(),[),(],][,)(,](,)[) “value” is expected +to be an array of two numbers where the first +is the lower bound and the second is the upper +bound.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable 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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.histogram2dcontour.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of the contour level. Has no +effect if contours.coloring is set to +“lines”.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
smoothing
Sets the amount of smoothing for the contour +lines, where 0 corresponds to no smoothing.
+
+
width
Sets the contour line width in (in px)
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
color
Sets the aggregation data.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2dcontour.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2dcontour.Stream
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property x¶

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¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the x axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each x axis bin. Default +behavior: If nbinsx is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsx is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the x axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the 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¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the y axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each y axis bin. Default +behavior: If nbinsy is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsy is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the y axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property 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 rule using d3 formatting mini- +languages which are very similar to those in Python. See: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property zmax¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=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¶

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

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autobiny¶

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

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autocolorscale¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.histogr +am2d.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.histogram2d.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of +histogram2d.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.histogram2d.colorb +ar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +histogram2d.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +histogram2d.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property histfunc¶

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¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable 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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.histogram2d.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
color
Sets the aggregation data.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2d.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property nbinsx¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2d.Stream
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property x¶

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¶

Returns: +
Return type: str
+

+ +

+property xbingroup¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the x axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each x axis bin. Default +behavior: If nbinsx is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsx is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the x axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘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 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¶

Returns: +
Return type: str
+

+ +

+property ybingroup¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the y axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each y axis bin. Default +behavior: If nbinsy is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsy is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the y axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘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 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¶

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

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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.Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property autobinx¶

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

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autobiny¶

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 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
+
Supported dict properties:
+
+
+
currentbin
Only applies if cumulative is enabled. Sets +whether the current bin is included, excluded, +or has half of its value included in the +current cumulative value. “include” is the +default for compatibility with various other +tools, however it introduces a half-bin bias to +the results. “exclude” makes the opposite half- +bin bias, and “half” removes it.
+
+
direction
Only applies if cumulative is enabled. If +“increasing” (default) we sum all prior bins, +so the result increases from left to right. If +“decreasing” we sum later bins so the result +decreases from left to right.
+
+
enabled
If true, display the cumulative distribution by +summing the binned values. Use the direction +and centralbin attributes to tune the +accumulation method. Note: in this mode, the +“density” histnorm settings behave the same +as their equivalents without “density”: “” and +“density” both rise to the number of data +points, and “probability” and probability +density both rise to the number of sample +points.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.ErrorY
+

+ +

+property histfunc¶

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¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable 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 legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.histogram.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.histogram.marker.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.histogram.marker.L +ine instance or dict with compatible +properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property nbinsx¶

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¶

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 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.histogram.selected +.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.histogram.selected +.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.histogram.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

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

+
+
An instance of plotly.graph_objects.histogram.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.histogram.unselect +ed.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.histogram.unselect +ed.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the x axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each x axis bin. Default +behavior: If nbinsx is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsx is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1). If multiple non-overlaying histograms +share a subplot, the first explicit size is +used and all others discarded. If no size is +provided,the sample data from all traces is +combined to determine size as described +above.
+
+
start
Sets the starting value for the x axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5. If multiple non- +overlaying histograms share a subplot, the +first explicit start is used exactly and all +others are shifted down (if necessary) to +differ from that one by an integer number of +bins.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property y¶

Sets the 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¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the y axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each y axis bin. Default +behavior: If nbinsy is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsy is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1). If multiple non-overlaying histograms +share a subplot, the first explicit size is +used and all others discarded. If no size is +provided,the sample data from all traces is +combined to determine size as described +above.
+
+
start
Sets the starting value for the y axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5. If multiple non- +overlaying histograms share a subplot, the +first explicit start is used exactly and all +others are shifted down (if necessary) to +differ from that one by an integer number of +bins.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Heatmapgl(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.heatmapgl.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.heatmap +gl.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.heatmapgl.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of heatmapgl.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.heatmapgl.colorbar +.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +heatmapgl.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +heatmapgl.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.heatmapgl.ColorBar
+

+ +

+property colorscale¶

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property 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.heatmapgl.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.heatmapgl.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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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 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.heatmapgl.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.heatmapgl.Stream
+

+ +

+property text¶

Sets the text elements associated with each z value.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

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

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property x¶

Sets the x coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

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

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property xtype¶

If “array”, the heatmap’s x coordinates are given by “x” (the +default behavior when x is provided). If “scaled”, the +heatmap’s x coordinates are given by “x0” and “dx” (the default +behavior when x is not provided).

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

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

Returns: +
Return type: Any
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

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

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property ytype¶

If “array”, the heatmap’s y coordinates are given by “y” (the +default behavior when y is provided) If “scaled”, the +heatmap’s y coordinates are given by “y0” and “dy” (the default +behavior when y is not provided)

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

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

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the z data.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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

Returns: +
Return type: bool
+

+ +

+property 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.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, legendgroup=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.heatmap.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.heatmap +.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.heatmap.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of heatmap.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.heatmap.colorbar.T +itle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +heatmap.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +heatmap.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

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

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

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

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property x¶

Sets the x coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

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

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

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

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

Returns: +
Return type: Any
+

+ +

+property 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 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¶

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

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

Returns: +
Return type: Any
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

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

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

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

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

Returns: +
Return type: Any
+

+ +

+property 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 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¶

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

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

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the z data.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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.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, legendgroup=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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this funnelarea +trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this funnelarea trace +.
+
+
x
Sets the horizontal domain of this funnelarea +trace (in plot fraction).
+
+
y
Sets the vertical domain of this funnelarea +trace (in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.funnelarea.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
colors
Sets the color of each sector. If not +specified, the default trace color set is used +to pick the sector colors.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
line
plotly.graph_objects.funnelarea.marker. +Line instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnelarea.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnelarea.Stream
+

+ +

+property text¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
font
Sets the font used for title. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
position
Specifies the location of the title. Note +that the title’s position used to be set by the +now deprecated titleposition attribute.
+
+
text
Sets the title of the chart. If it is empty, no +title is displayed. Note that before the +existence of title.text, the title’s contents +used to be defined as the title attribute +itself. This behavior has been deprecated.
+
+
+
+
+
+

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¶

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.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, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
fillcolor
Sets the fill color.
+
+
line
plotly.graph_objects.funnel.connector.L +ine instance or dict with compatible +properties
+
+
visible
Determines if connector regions and lines are +drawn.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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

Returns: +
Return type: plotly.graph_objects.funnel.Insidetextfont
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

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

+
+
An instance of plotly.graph_objects.funnel.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.funnel.marker.Colo +rBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
:class:`plotly.graph_objects.funnel.marker.Line +` instance or dict with compatible properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnel.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

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

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

An int or float

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

Returns: +
Return type: plotly.graph_objects.funnel.Outsidetextfont
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.funnel.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnel.Stream
+

+ +

+property text¶

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¶

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

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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¶

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¶

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

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

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

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

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property below¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.densitymapbox.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.density +mapbox.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.densitymapbox.colorbar.tickformatstopdefaults +), sets the default property values to use for +elements of +densitymapbox.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.densitymapbox.colo +rbar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +densitymapbox.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +densitymapbox.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.densitymapbox.ColorBar
+

+ +

+property colorscale¶

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘lon’, ‘lat’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘lon+lat’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

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

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

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

+
+
An instance of plotly.graph_objects.densitymapbox.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.densitymapbox.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property lat¶

Sets the latitude coordinates (in degrees North).

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property latsrc¶

Sets the source reference on Chart Studio Cloud for lat .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lon¶

Sets the longitude coordinates (in degrees East).

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property lonsrc¶

Sets the source reference on Chart Studio Cloud for lon .

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

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property radius¶

Sets the radius of influence of one lon / lat point in +pixels. Increasing the value makes the densitymapbox trace +smoother, but less detailed.

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

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

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property radiussrc¶

Sets the source reference on Chart Studio Cloud for radius .

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

Returns: +
Return type: str
+

+ +

+property reversescale¶

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

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

Returns: +
Return type: bool
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.densitymapbox.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.densitymapbox.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the points’ weight. For example, a value of 10 would be +equivalent to having 10 points of weight 1 in the same spot

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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

Returns: +
Return type: bool
+

+ +

+property zmax¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Contourcarpet(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property a¶

Sets the x coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property a0¶

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

The ‘a0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property asrc¶

Sets the source reference on Chart Studio Cloud for a .

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

Returns: +
Return type: str
+

+ +

+property atype¶

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

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

Returns: +
Return type: Any
+

+ +

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property autocontour¶

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

Returns: +
Return type: bool
+

+ +

+property b¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property b0¶

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

The ‘b0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property bsrc¶

Sets the source reference on Chart Studio Cloud for b .

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

Returns: +
Return type: str
+

+ +

+property btype¶

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

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

Returns: +
Return type: Any
+

+ +

+property carpet¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.contourcarpet.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.contour +carpet.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.contourcarpet.colorbar.tickformatstopdefaults +), sets the default property values to use for +elements of +contourcarpet.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.contourcarpet.colo +rbar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +contourcarpet.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +contourcarpet.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.ColorBar
+

+ +

+property colorscale¶

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property contours¶

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

+
+
An instance of plotly.graph_objects.contourcarpet.Contours
+
A dict of string/value properties that will be passed +to the Contours constructor
+
Supported dict properties:
+
+
+
coloring
Determines the coloring method showing the +contour values. If “fill”, coloring is done +evenly between each contour level If “lines”, +coloring is done on the contour lines. If +“none”, no coloring is applied on this trace.
+
+
end
Sets the end contour level value. Must be more +than contours.start
+
+
labelfont
Sets the font used for labeling the contour +levels. The default color comes from the lines, +if shown. The default family and size come from +layout.font.
+
+
labelformat
Sets the contour label formatting rule using d3 +formatting mini-language which is very similar +to Python, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
operation
Sets the constraint operation. “=” keeps +regions equal to value “<” and “<=” keep +regions less than value “>” and “>=” keep +regions greater than value “[]”, “()”, “[)”, +and “(]” keep regions inside value[0] to +value[1] “][“, “)(“, “](“, “)[” keep regions +outside value[0] to value[1]` Open vs. closed +intervals make no difference to constraint +display, but all versions are allowed for +consistency with filter transforms.
+
+
showlabels
Determines whether to label the contour lines +with their values.
+
+
showlines
Determines whether or not the contour lines are +drawn. Has an effect only if +contours.coloring is set to “fill”.
+
+
size
Sets the step between each contour level. Must +be positive.
+
+
start
Sets the starting contour level value. Must be +less than contours.end
+
+
type
If levels, the data is represented as a +contour plot with multiple levels displayed. If +constraint, the data is represented as +constraints with the invalid region shaded as +specified by the operation and value +parameters.
+
+
value
Sets the value or values of the constraint +boundary. When operation is set to one of the +comparison values (=,<,>=,>,<=) “value” is +expected to be a number. When operation is +set to one of the interval values +([],(),[),(],][,)(,](,)[) “value” is expected +to be an array of two numbers where the first +is the lower bound and the second is the upper +bound.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.Contours
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property da¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property db¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property fillcolor¶

Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line color, +marker color, or marker line color, whichever is available.

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

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

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.contourcarpet.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of the contour level. Has no +effect if contours.coloring is set to +“lines”.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
smoothing
Sets the amount of smoothing for the contour +lines, where 0 corresponds to no smoothing.
+
+
width
Sets the contour line width in (in px) Defaults +to 0.5 when contours.type is “levels”. +Defaults to 2 when contour.type is +“constraint”.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property ncontours¶

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

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

Returns: +
Return type: int
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property reversescale¶

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

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

Returns: +
Return type: bool
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.contourcarpet.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.Stream
+

+ +

+property text¶

Sets the text elements associated with each z value.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

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

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property z¶

Sets the z data.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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

Returns: +
Return type: bool
+

+ +

+property zmax¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

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

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Contour(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property autocontour¶

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

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.contour.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.contour +.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.contour.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of contour.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.contour.colorbar.T +itle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +contour.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +contour.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.ColorBar
+

+ +

+property colorscale¶

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

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property connectgaps¶

Determines whether or not gaps (i.e. {nan} or missing values) +in the z data are filled in. It is defaulted to true if z +is a one dimensional array otherwise it is defaulted to false.

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

Returns: +
Return type: bool
+

+ +

+property contours¶

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

+
+
An instance of plotly.graph_objects.contour.Contours
+
A dict of string/value properties that will be passed +to the Contours constructor
+
Supported dict properties:
+
+
+
coloring
Determines the coloring method showing the +contour values. If “fill”, coloring is done +evenly between each contour level If “heatmap”, +a heatmap gradient coloring is applied between +each contour level. If “lines”, coloring is +done on the contour lines. If “none”, no +coloring is applied on this trace.
+
+
end
Sets the end contour level value. Must be more +than contours.start
+
+
labelfont
Sets the font used for labeling the contour +levels. The default color comes from the lines, +if shown. The default family and size come from +layout.font.
+
+
labelformat
Sets the contour label formatting rule using d3 +formatting mini-language which is very similar +to Python, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
operation
Sets the constraint operation. “=” keeps +regions equal to value “<” and “<=” keep +regions less than value “>” and “>=” keep +regions greater than value “[]”, “()”, “[)”, +and “(]” keep regions inside value[0] to +value[1] “][“, “)(“, “](“, “)[” keep regions +outside value[0] to value[1]` Open vs. closed +intervals make no difference to constraint +display, but all versions are allowed for +consistency with filter transforms.
+
+
showlabels
Determines whether to label the contour lines +with their values.
+
+
showlines
Determines whether or not the contour lines are +drawn. Has an effect only if +contours.coloring is set to “fill”.
+
+
size
Sets the step between each contour level. Must +be positive.
+
+
start
Sets the starting contour level value. Must be +less than contours.end
+
+
type
If levels, the data is represented as a +contour plot with multiple levels displayed. If +constraint, the data is represented as +constraints with the invalid region shaded as +specified by the operation and value +parameters.
+
+
value
Sets the value or values of the constraint +boundary. When operation is set to one of the +comparison values (=,<,>=,>,<=) “value” is +expected to be a number. When operation is +set to one of the interval values +([],(),[),(],][,)(,](,)[) “value” is expected +to be an array of two numbers where the first +is the lower bound and the second is the upper +bound.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Contours
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property dx¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property dy¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property fillcolor¶

Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line color, +marker color, or marker line color, whichever is available.

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

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

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

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

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

+
+
An instance of plotly.graph_objects.contour.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Hoverlabel
+

+ +

+property hoverongaps¶

Determines whether or not gaps (i.e. {nan} or missing values) +in the z data have hover labels associated with them.

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

Returns: +
Return type: bool
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

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

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

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

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

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

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

Returns: +
Return type: str
+

+ +

+property ids¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

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

Returns: +
Return type: str
+

+ +

+property legendgroup¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

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

+
+
An instance of plotly.graph_objects.contour.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of the contour level. Has no +effect if contours.coloring is set to +“lines”.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
smoothing
Sets the amount of smoothing for the contour +lines, where 0 corresponds to no smoothing.
+
+
width
Sets the contour line width in (in px) Defaults +to 0.5 when contours.type is “levels”. +Defaults to 2 when contour.type is +“constraint”.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

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

Returns: +
Return type: str
+

+ +

+property name¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property ncontours¶

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

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

Returns: +
Return type: int
+

+ +

+property opacity¶

Sets the opacity of the trace.

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

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

Returns: +
Return type: int|float
+

+ +

+property reversescale¶

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

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

Returns: +
Return type: bool
+

+ +

+property showlegend¶

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

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

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

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

Returns: +
Return type: bool
+

+ +

+property stream¶

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

+
+
An instance of plotly.graph_objects.contour.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Stream
+

+ +

+property text¶

Sets the text elements associated with each z value.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

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

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

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

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

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

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

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

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

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

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

Returns: +
Return type: Any
+

+ +

+property x¶

Sets the x coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

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

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

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

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

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

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

Returns: +
Return type: str
+

+ +

+property xtype¶

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

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

Returns: +
Return type: Any
+

+ +

+property y¶

Sets the y coordinates.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

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

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

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

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

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

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

Returns: +
Return type: str
+

+ +

+property ytype¶

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

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

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the z data.

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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

Bases: plotly.basedatatypes.BaseTraceType

+property anchor¶

Sets the cones’ anchor with respect to their x/y/z positions. +Note that “cm” denote the cone’s center of mass which +corresponds to 1/4 from the tail to tip.

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

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

Returns: +
Return type: Any
+

+ +

+property autocolorscale¶

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

Returns: +
Return type: bool
+

+ +

+property cauto¶

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

Returns: +
Return type: bool
+

+ +

+property cmax¶

Sets the upper bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmin must be set as +well.

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmid¶

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

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmin¶

Sets the lower bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmax must be set as +well.

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

An int or float

Returns: +
Return type: int|float
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

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

+
+
An instance of plotly.graph_objects.cone.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.cone.co +lorbar.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.cone.colorbar.tickformatstopdefaults), sets +the default property values to use for elements +of cone.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.cone.colorbar.Titl +e instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use cone.colorbar.title.font +instead. Sets this color bar’s title font. Note +that the title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use cone.colorbar.title.side +instead. Determines the location of color bar’s +title with respect to the color bar. Note that +the title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.ColorBar
+

+ +

+property colorscale¶

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

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

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

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

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

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

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

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

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

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘u’, ‘v’, ‘w’, ‘norm’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

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

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

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

+
+
An instance of plotly.graph_objects.cone.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable norm Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary box +completely, use an empty tag <extra></extra>.

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

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

The ‘lighting’ property is an instance of Lighting +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Lighting
+

+ +

+property lightposition¶

The ‘lightposition’ property is an instance of Lightposition +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Lightposition
+
A dict of string/value properties that will be passed +to the Lightposition constructor
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

Returns: +
Return type: str
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property sizemode¶

Determines whether sizeref is set as a “scaled” (i.e +unitless) scalar (normalized by the max u/v/w norm in the +vector field) or as “absolute” value (in the same units as the +vector field).

The ‘sizemode’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘scaled’, ‘absolute’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property sizeref¶

Adjusts the cone size scaling. The size of the cones is +determined by their u/v/w norm multiplied a factor and +sizeref. This factor (computed internally) corresponds to the +minimum “time” to travel across two successive x/y/z positions +at the average velocity of those two successive positions. All +cones in a given trace use the same factor. With sizemode set +to “scaled”, sizeref is unitless, its default value is 0.5 +With sizemode set to “absolute”, sizeref has the same units +as the u/v/w vector field, its the default value is half the +sample’s maximum vector norm.

The ‘sizeref’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns: +
Return type: int|float
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Stream
+

+ +

+property text¶

Sets the text elements associated with the cones. If trace +hoverinfo contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property u¶

Sets the x components of the vector field.

The ‘u’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property usrc¶

Sets the source reference on Chart Studio Cloud for u .

The ‘usrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property v¶

Sets the y components of the vector field.

The ‘v’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property vsrc¶

Sets the source reference on Chart Studio Cloud for v .

The ‘vsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property w¶

Sets the z components of the vector field.

The ‘w’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property wsrc¶

Sets the source reference on Chart Studio Cloud for w .

The ‘wsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property x¶

Sets the x coordinates of the vector field and of the displayed +cones.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates of the vector field and of the displayed +cones.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property z¶

Sets the z coordinates of the vector field and of the displayed +cones.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Choroplethmapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property below¶

Determines if the choropleth polygons will be inserted before +the layer with the specified ID. By default, choroplethmapbox +traces are placed above the water layers. If set to ‘’, the +layer will be inserted above every existing layer.

The ‘below’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.choropl +ethmapbox.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.choroplethmapbox.colorbar.tickformatstopdefau +lts), sets the default property values to use +for elements of +choroplethmapbox.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.choroplethmapbox.c +olorbar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +choroplethmapbox.colorbar.title.font instead. +Sets this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +choroplethmapbox.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property featureidkey¶

Sets the key in GeoJSON features which is used as id to match +the items included in the locations array. Support nested +property, for example “properties.name”.

The ‘featureidkey’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property geojson¶

Sets the GeoJSON data associated with this trace. It can be set +as a valid GeoJSON object or as a URL string. Note that we only +accept GeoJSONs of type “FeatureCollection” or “Feature” with +geometries of type “Polygon” or “MultiPolygon”.

The ‘geojson’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘location+z’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable properties Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary box +completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property locations¶

Sets which features found in “geojson” to plot using their +feature id field.

The ‘locations’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property locationssrc¶

Sets the source reference on Chart Studio Cloud for locations +.

The ‘locationssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.choroplethmapbox.m +arker.Line instance or dict with compatible +properties
+
+
opacity
Sets the opacity of the locations.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choroplethmapbox.s +elected.Marker instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

Sets the text elements associated with each location.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choroplethmapbox.u +nselected.Marker instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the color values.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zmax¶

Sets the upper bound of the color domain. Value should have the +same units as in z and if set, zmin must be set as well.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

Sets the mid-point of the color domain by scaling zmin and/or +zmax to be equidistant to this point. Value should have the +same units as in z. Has no effect when zauto is false.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

Sets the lower bound of the color domain. Value should have the +same units as in z and if set, zmax must be set as well.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Choropleth(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.choropl +eth.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.choropleth.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of choropleth.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.choropleth.colorba +r.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +choropleth.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +choropleth.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property featureidkey¶

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¶

Returns: +
Return type: str
+

+ +

+property geojson¶

Sets optional GeoJSON data associated with this trace. If not +given, the features on the base map are used. It can be set as +a valid GeoJSON object or as a URL string. Note that we only +accept GeoJSONs of type “FeatureCollection” or “Feature” with +geometries of type “Polygon” or “MultiPolygon”.

The ‘geojson’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘location+z’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property locationmode¶

The ‘locationmode’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘ISO-3’, ‘USA-states’, ‘country names’, ‘geojson-id’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property locations¶

Sets the coordinates via location IDs or names. See +locationmode for more info.

The ‘locations’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property locationssrc¶

Sets the source reference on Chart Studio Cloud for locations +.

The ‘locationssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.choropleth.marker. +Line instance or dict with compatible +properties
+
+
opacity
Sets the opacity of the locations.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choropleth.selecte +d.Marker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Stream
+

+ +

+property text¶

Sets the text elements associated with each location.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choropleth.unselec +ted.Marker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the color values.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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.Carpet(arg=None, a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property a¶

An array containing values of the first parameter value

The ‘a’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property a0¶

Alternate to a. Builds a linear space of a coordinates. Use +with da where a0 is the starting coordinate and da the +step.

The ‘a0’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property aaxis¶

The ‘aaxis’ property is an instance of Aaxis +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Aaxis
+
A dict of string/value properties that will be passed +to the Aaxis constructor
+
Supported dict properties:
+
+
+
arraydtick
The stride between grid lines along the axis
+
+
arraytick0
The starting index of grid lines along the axis
+
+
autorange
Determines whether or not the range of this +axis is computed in relation to the input data. +See rangemode for more info. If range is +provided, then autorange is set to False.
+
+
categoryarray
Sets the order in which categories on this axis +appear. Only has an effect if categoryorder +is set to “array”. Used with categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the case of +categorical variables. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray.
+
+
+
cheatertype
+
+
color
Sets default for all colors associated with +this axis all at once: line, font, tick, and +grid colors. Grid color is lightened by +blending this with the plot background +Individual pieces can override this.
+
+
dtick
The stride between grid lines along the axis
+
+
endline
Determines whether or not a line is drawn at +along the final value of this axis. If True, +the end line is drawn on top of the grid lines.
+
+
endlinecolor
Sets the line color of the end line.
+
+
endlinewidth
Sets the width (in px) of the end line.
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
fixedrange
Determines whether or not this axis is zoom- +able. If true, then zoom is disabled.
+
+
gridcolor
Sets the axis line color.
+
+
gridwidth
Sets the width (in px) of the axis line.
+
+
labelpadding
Extra padding between label and the axis
+
+
labelprefix
Sets a axis label prefix.
+
+
labelsuffix
Sets a axis label suffix.
+
+
linecolor
Sets the axis line color.
+
+
linewidth
Sets the width (in px) of the axis line.
+
+
minorgridcolor
Sets the color of the grid lines.
+
+
minorgridcount
Sets the number of minor grid ticks per major +grid tick
+
+
minorgridwidth
Sets the width (in px) of the grid lines.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
range
Sets the range of this axis. If the axis type +is “log”, then you must take the log of your +desired range (e.g. to set the range from 1 to +100, set the range from 0 to 2). If the axis +type is “date”, it should be date strings, +like date data, though Date objects and unix +milliseconds will be accepted and converted to +strings. If the axis type is “category”, it +should be numbers, using the scale where each +category is assigned a serial number from zero +in the order it appears.
+
+
rangemode
If “normal”, the range is computed in relation +to the extrema of the input data. If *tozero*`, +the range extends to 0, regardless of the input +data If “nonnegative”, the range is non- +negative, regardless of the input data.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showgrid
Determines whether or not grid lines are drawn. +If True, the grid lines are drawn at every tick +mark.
+
+
showline
Determines whether or not a line bounding this +axis is drawn.
+
+
showticklabels
Determines whether axis labels are drawn on the +low side, the high side, both, or neither side +of the axis.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
+
smoothing
+
+
startline
Determines whether or not a line is drawn at +along the starting value of this axis. If True, +the start line is drawn on top of the grid +lines.
+
+
startlinecolor
Sets the line color of the start line.
+
+
startlinewidth
Sets the width (in px) of the start line.
+
+
tick0
The starting index of grid lines along the axis
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickfont
Sets the tick font.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: We add one item to d3’s +date formatter: “%{n}f” for fractional seconds +with n digits. For example, 2016-10-13 +09:15:23.456 with tickformat “%H~%M~%S.%2f” +would display “09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.carpet. +aaxis.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.carpet.aaxis.tickformatstopdefaults), sets +the default property values to use for elements +of carpet.aaxis.tickformatstops
+
+
+
tickmode
+
+
tickprefix
Sets a tick label prefix.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
title
:class:`plotly.graph_objects.carpet.aaxis.Title +` instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use carpet.aaxis.title.font +instead. Sets this axis’ title font. Note that +the title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleoffset
Deprecated: Please use +carpet.aaxis.title.offset instead. An +additional amount by which to offset the title +from the tick labels, given in pixels. Note +that this used to be set by the now deprecated +titleoffset attribute.
+
+
type
Sets the axis type. By default, plotly attempts +to determined the axis type by looking into the +data of the traces that referenced the axis in +question.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Aaxis
+

+ +

+property asrc¶

Sets the source reference on Chart Studio Cloud for a .

The ‘asrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property b¶

A two dimensional array of y coordinates at each carpet point.

The ‘b’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property b0¶

Alternate to b. Builds a linear space of a coordinates. Use +with db where b0 is the starting coordinate and db the +step.

The ‘b0’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property baxis¶

The ‘baxis’ property is an instance of Baxis +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Baxis
+
A dict of string/value properties that will be passed +to the Baxis constructor
+
Supported dict properties:
+
+
+
arraydtick
The stride between grid lines along the axis
+
+
arraytick0
The starting index of grid lines along the axis
+
+
autorange
Determines whether or not the range of this +axis is computed in relation to the input data. +See rangemode for more info. If range is +provided, then autorange is set to False.
+
+
categoryarray
Sets the order in which categories on this axis +appear. Only has an effect if categoryorder +is set to “array”. Used with categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the case of +categorical variables. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray.
+
+
+
cheatertype
+
+
color
Sets default for all colors associated with +this axis all at once: line, font, tick, and +grid colors. Grid color is lightened by +blending this with the plot background +Individual pieces can override this.
+
+
dtick
The stride between grid lines along the axis
+
+
endline
Determines whether or not a line is drawn at +along the final value of this axis. If True, +the end line is drawn on top of the grid lines.
+
+
endlinecolor
Sets the line color of the end line.
+
+
endlinewidth
Sets the width (in px) of the end line.
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
fixedrange
Determines whether or not this axis is zoom- +able. If true, then zoom is disabled.
+
+
gridcolor
Sets the axis line color.
+
+
gridwidth
Sets the width (in px) of the axis line.
+
+
labelpadding
Extra padding between label and the axis
+
+
labelprefix
Sets a axis label prefix.
+
+
labelsuffix
Sets a axis label suffix.
+
+
linecolor
Sets the axis line color.
+
+
linewidth
Sets the width (in px) of the axis line.
+
+
minorgridcolor
Sets the color of the grid lines.
+
+
minorgridcount
Sets the number of minor grid ticks per major +grid tick
+
+
minorgridwidth
Sets the width (in px) of the grid lines.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
range
Sets the range of this axis. If the axis type +is “log”, then you must take the log of your +desired range (e.g. to set the range from 1 to +100, set the range from 0 to 2). If the axis +type is “date”, it should be date strings, +like date data, though Date objects and unix +milliseconds will be accepted and converted to +strings. If the axis type is “category”, it +should be numbers, using the scale where each +category is assigned a serial number from zero +in the order it appears.
+
+
rangemode
If “normal”, the range is computed in relation +to the extrema of the input data. If *tozero*`, +the range extends to 0, regardless of the input +data If “nonnegative”, the range is non- +negative, regardless of the input data.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showgrid
Determines whether or not grid lines are drawn. +If True, the grid lines are drawn at every tick +mark.
+
+
showline
Determines whether or not a line bounding this +axis is drawn.
+
+
showticklabels
Determines whether axis labels are drawn on the +low side, the high side, both, or neither side +of the axis.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
+
smoothing
+
+
startline
Determines whether or not a line is drawn at +along the starting value of this axis. If True, +the start line is drawn on top of the grid +lines.
+
+
startlinecolor
Sets the line color of the start line.
+
+
startlinewidth
Sets the width (in px) of the start line.
+
+
tick0
The starting index of grid lines along the axis
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickfont
Sets the tick font.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: We add one item to d3’s +date formatter: “%{n}f” for fractional seconds +with n digits. For example, 2016-10-13 +09:15:23.456 with tickformat “%H~%M~%S.%2f” +would display “09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.carpet. +baxis.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.carpet.baxis.tickformatstopdefaults), sets +the default property values to use for elements +of carpet.baxis.tickformatstops
+
+
+
tickmode
+
+
tickprefix
Sets a tick label prefix.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
title
:class:`plotly.graph_objects.carpet.baxis.Title +` instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use carpet.baxis.title.font +instead. Sets this axis’ title font. Note that +the title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleoffset
Deprecated: Please use +carpet.baxis.title.offset instead. An +additional amount by which to offset the title +from the tick labels, given in pixels. Note +that this used to be set by the now deprecated +titleoffset attribute.
+
+
type
Sets the axis type. By default, plotly attempts +to determined the axis type by looking into the +data of the traces that referenced the axis in +question.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Baxis
+

+ +

+property bsrc¶

Sets the source reference on Chart Studio Cloud for b .

The ‘bsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property carpet¶

An identifier for this carpet, so that scattercarpet and +contourcarpet traces can specify a carpet plot on which they +lie

The ‘carpet’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property cheaterslope¶

The shift applied to each successive row of data in creating a +cheater plot. Only used if x is been ommitted.

The ‘cheaterslope’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property color¶

Sets default for all colors associated with this axis all at +once: line, font, tick, and grid colors. Grid color is +lightened by blending this with the plot background Individual +pieces can override this.

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
+
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property da¶

Sets the a coordinate step. See a0 for more info.

The ‘da’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property db¶

Sets the b coordinate step. See b0 for more info.

The ‘db’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property font¶

The default font used for axis & tick labels on this carpet

The ‘font’ property is an instance of Font +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Font
+
A dict of string/value properties that will be passed +to the Font constructor
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Font
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Stream
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

A two dimensional array of x coordinates at each carpet point. +If ommitted, the plot is a cheater plot and the xaxis is hidden +by default.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

A two dimensional array of y coordinates at each carpet point.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Candlestick(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legendgroup=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property close¶

Sets the close values.

The ‘close’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property closesrc¶

Sets the source reference on Chart Studio Cloud for close .

The ‘closesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property decreasing¶

The ‘decreasing’ property is an instance of Decreasing +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Decreasing
+
A dict of string/value properties that will be passed +to the Decreasing constructor
+
Supported dict properties:
+
+
+
fillcolor
Sets the fill color. Defaults to a half- +transparent variant of the line color, marker +color, or marker line color, whichever is +available.
+
+
line
plotly.graph_objects.candlestick.decrea +sing.Line instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Decreasing
+

+ +

+property high¶

Sets the high values.

The ‘high’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property highsrc¶

Sets the source reference on Chart Studio Cloud for high .

The ‘highsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
split
Show hover information (open, close, high, low) +in separate labels.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Hoverlabel
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property increasing¶

The ‘increasing’ property is an instance of Increasing +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Increasing
+
A dict of string/value properties that will be passed +to the Increasing constructor
+
Supported dict properties:
+
+
+
fillcolor
Sets the fill color. Defaults to a half- +transparent variant of the line color, marker +color, or marker line color, whichever is +available.
+
+
line
plotly.graph_objects.candlestick.increa +sing.Line instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Increasing
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
width
Sets the width (in px) of line bounding the +box(es). Note that this style setting can also +be set per direction via +increasing.line.width and +decreasing.line.width.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Line
+

+ +

+property low¶

Sets the low values.

The ‘low’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property lowsrc¶

Sets the source reference on Chart Studio Cloud for low .

The ‘lowsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property open¶

Sets the open values.

The ‘open’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property opensrc¶

Sets the source reference on Chart Studio Cloud for open .

The ‘opensrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property whiskerwidth¶

Sets the width of the whiskers relative to the box’ width. For +example, with 1, the whiskers are as wide as the box(es).

The ‘whiskerwidth’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property x¶

Sets the x coordinates. If absent, linear coordinate will be +generated.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Box(arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legendgroup=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property boxmean¶

If True, the mean of the box(es)’ underlying distribution is +drawn as a dashed line inside the box(es). If “sd” the standard +deviation is also drawn. Defaults to True when mean is set. +Defaults to “sd” when sd is set Otherwise defaults to False.

The ‘boxmean’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, ‘sd’, False]
+
+
+

Returns: +
Return type: Any
+

+ +

+property boxpoints¶

If “outliers”, only the sample points lying outside the +whiskers are shown If “suspectedoutliers”, the outlier points +are shown and points either less than 4*Q1-3*Q3 or greater than +4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all +sample points are shown If False, only the box(es) are shown +with no sample points Defaults to “suspectedoutliers” when +marker.outliercolor or marker.line.outliercolor is set. +Defaults to “all” under the q1/median/q3 signature. Otherwise +defaults to “outliers”.

The ‘boxpoints’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘all’, ‘outliers’, ‘suspectedoutliers’, False]
+
+
+

Returns: +
Return type: Any
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dx¶

Sets the x coordinate step for multi-box traces set using +q1/median/q3.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dy¶

Sets the y coordinate step for multi-box traces set using +q1/median/q3.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property fillcolor¶

Sets the fill color. Defaults to a half-transparent variant of +the line color, marker color, or marker line color, whichever +is available.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
+
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Hoverlabel
+

+ +

+property hoveron¶

Do the hover effects highlight individual boxes or sample +points or both?

The ‘hoveron’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘boxes’, ‘points’] joined with ‘+’ characters +(e.g. ‘boxes+points’)
+
+

Returns: +
Return type: Any
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘jitter’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of line bounding the box(es).
+
+
width
Sets the width (in px) of line bounding the +box(es).
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Line
+

+ +

+property lowerfence¶

Sets the lower fence values. There should be as many items as +the number of boxes desired. This attribute has effect only +under the q1/median/q3 signature. If lowerfence is not +provided but a sample (in y or x) is set, we compute the +lower as the last sample point below 1.5 times the IQR.

The ‘lowerfence’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property lowerfencesrc¶

Sets the source reference on Chart Studio Cloud for lowerfence +.

The ‘lowerfencesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
line
plotly.graph_objects.box.marker.Line +instance or dict with compatible properties
+
+
opacity
Sets the marker opacity.
+
+
outliercolor
Sets the color of the outlier sample points.
+
+
size
Sets the marker size (in px).
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Marker
+

+ +

+property mean¶

Sets the mean values. There should be as many items as the +number of boxes desired. This attribute has effect only under +the q1/median/q3 signature. If mean is not provided but a +sample (in y or x) is set, we compute the mean for each box +using the sample values.

The ‘mean’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property meansrc¶

Sets the source reference on Chart Studio Cloud for mean .

The ‘meansrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property median¶

Sets the median values. There should be as many items as the +number of boxes desired.

The ‘median’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property mediansrc¶

Sets the source reference on Chart Studio Cloud for median .

The ‘mediansrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover. For box traces, the name will also be used for +the position coordinate, if x and x0 (y and y0 if +horizontal) are missing and the position axis is categorical

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property notched¶

Determines whether or not notches are drawn. Notches displays a +confidence interval around the median. We compute the +confidence interval as median +/- 1.57 * IQR / sqrt(N), where +IQR is the interquartile range and N is the sample size. If two +boxes’ notches do not overlap there is 95% confidence their +medians differ. See +https://sites.google.com/site/davidsstatistics/home/notched- +box-plots for more info. Defaults to False unless notchwidth +or notchspan is set.

The ‘notched’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property notchspan¶

Sets the notch span from the boxes’ median values. There +should be as many items as the number of boxes desired. This +attribute has effect only under the q1/median/q3 signature. If +notchspan is not provided but a sample (in y or x) is +set, we compute it as 1.57 * IQR / sqrt(N), where N is the +sample size.

The ‘notchspan’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property notchspansrc¶

Sets the source reference on Chart Studio Cloud for notchspan +.

The ‘notchspansrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property notchwidth¶

Sets the width of the notches relative to the box’ width. For +example, with 0, the notches are as wide as the box(es).

The ‘notchwidth’ property is a number and may be specified as:

An int or float in the interval [0, 0.5]

Returns: +
Return type: int|float
+

+ +

+property offsetgroup¶

Set several traces linked to the same position axis or matching +axes to the same offsetgroup where bars of the same position +coordinate will line up.

The ‘offsetgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property orientation¶

Sets the orientation of the box(es). If “v” (“h”), the +distribution is visualized along the vertical (horizontal).

The ‘orientation’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘v’, ‘h’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property pointpos¶

Sets the position of the sample points in relation to the +box(es). If 0, the sample points are places over the center of +the box(es). Positive (negative) values correspond to positions +to the right (left) for vertical boxes and above (below) for +horizontal boxes

The ‘pointpos’ property is a number and may be specified as:

An int or float in the interval [-2, 2]

Returns: +
Return type: int|float
+

+ +

+property q1¶

Sets the Quartile 1 values. There should be as many items as +the number of boxes desired.

The ‘q1’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property q1src¶

Sets the source reference on Chart Studio Cloud for q1 .

The ‘q1src’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property q3¶

Sets the Quartile 3 values. There should be as many items as +the number of boxes desired.

The ‘q3’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property q3src¶

Sets the source reference on Chart Studio Cloud for q3 .

The ‘q3src’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property quartilemethod¶

Sets the method used to compute the sample’s Q1 and Q3 +quartiles. The “linear” method uses the 25th percentile for Q1 +and 75th percentile for Q3 as computed using method #10 (listed +on http://www.amstat.org/publications/jse/v14n3/langford.html). +The “exclusive” method uses the median to divide the ordered +dataset into two halves if the sample is odd, it does not +include the median in either half - Q1 is then the median of +the lower half and Q3 the median of the upper half. The +“inclusive” method also uses the median to divide the ordered +dataset into two halves but if the sample is odd, it includes +the median in both halves - Q1 is then the median of the lower +half and Q3 the median of the upper half.

The ‘quartilemethod’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘linear’, ‘exclusive’, ‘inclusive’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property sd¶

Sets the standard deviation values. There should be as many +items as the number of boxes desired. This attribute has effect +only under the q1/median/q3 signature. If sd is not provided +but a sample (in y or x) is set, we compute the standard +deviation for each box using the sample values.

The ‘sd’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property sdsrc¶

Sets the source reference on Chart Studio Cloud for sd .

The ‘sdsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.box.selected.Marke +r instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.box.unselected.Mar +ker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Unselected
+

+ +

+property upperfence¶

Sets the upper fence values. There should be as many items as +the number of boxes desired. This attribute has effect only +under the q1/median/q3 signature. If upperfence is not +provided but a sample (in y or x) is set, we compute the +lower as the last sample point above 1.5 times the IQR.

The ‘upperfence’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property upperfencesrc¶

Sets the source reference on Chart Studio Cloud for upperfence +.

The ‘upperfencesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property whiskerwidth¶

Sets the width of the whiskers relative to the box’ width. For +example, with 1, the whiskers are as wide as the box(es).

The ‘whiskerwidth’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property width¶

Sets the width of the box in data coordinate If 0 (default +value) the width is automatically selected based on the +positions of other box traces in the same subplot.

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns: +
Return type: int|float
+

+ +

+property x¶

Sets the x sample data or coordinates. See overview for more +info.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Sets the x coordinate for single-box traces or the starting +coordinate for multi-box traces set using q1/median/q3. See +overview for more info.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y sample data or coordinates. See overview for more +info.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Sets the y coordinate for single-box traces or the starting +coordinate for multi-box traces set using q1/median/q3. See +overview for more info.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Barpolar(arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property base¶

Sets where the bar base is drawn (in radial axis units). In +“stack” barmode, traces that set “base” will be excluded and +drawn in “overlay” mode instead.

The ‘base’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property basesrc¶

Sets the source reference on Chart Studio Cloud for base .

The ‘basesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dr¶

Sets the r coordinate step.

The ‘dr’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dtheta¶

Sets the theta coordinate step. By default, the dtheta step +equals the subplot’s period divided by the length of the r +coordinates.

The ‘dtheta’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘r’, ‘theta’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘r+theta’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.barpolar.marker.Co +lorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.barpolar.marker.Li +ne instance or dict with compatible properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

Shifts the angular position where the bar is drawn (in +“thetatunit” units).

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property offsetsrc¶

Sets the source reference on Chart Studio Cloud for offset .

The ‘offsetsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property r¶

Sets the radial coordinates

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property r0¶

Alternate to r. Builds a linear space of r coordinates. Use +with dr where r0 is the starting coordinate and dr the +step.

The ‘r0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.barpolar.selected. +Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.barpolar.selected. +Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property theta¶

Sets the angular coordinates

The ‘theta’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property theta0¶

Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the starting +coordinate and dtheta the step.

The ‘theta0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property thetasrc¶

Sets the source reference on Chart Studio Cloud for theta .

The ‘thetasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property thetaunit¶

Sets the unit of input “theta” values. Has an effect only when +on “linear” angular axes.

The ‘thetaunit’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘radians’, ‘degrees’, ‘gradians’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.barpolar.unselecte +d.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.barpolar.unselecte +d.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property width¶

Sets the bar angular width (in “thetaunit” units).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property widthsrc¶

Sets the source reference on Chart Studio Cloud for width .

The ‘widthsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Bar(arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, t=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property base¶

Sets where the bar base is drawn (in position axis units). In +“stack” or “relative” barmode, traces that set “base” will be +excluded and drawn in “overlay” mode instead.

The ‘base’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property basesrc¶

Sets the source reference on Chart Studio Cloud for base .

The ‘basesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property cliponaxis¶

Determines whether the text nodes are clipped about the subplot +axes. To show the text nodes above axis lines and tick labels, +make sure to set xaxis.layer and yaxis.layer to below +traces.

The ‘cliponaxis’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property constraintext¶

Constrain the size of text inside or outside a bar to be no +larger than the bar itself.

The ‘constraintext’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘inside’, ‘outside’, ‘both’, ‘none’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dx¶

Sets the x coordinate step. See x0 for more info.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dy¶

Sets the y coordinate step. See y0 for more info.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property error_x¶

The ‘error_x’ property is an instance of ErrorX +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.ErrorX
+
A dict of string/value properties that will be passed +to the ErrorX constructor
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.ErrorX
+

+ +

+property error_y¶

The ‘error_y’ property is an instance of ErrorY +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.ErrorY
+
A dict of string/value properties that will be passed +to the ErrorY constructor
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.ErrorY
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables value and label. Anything contained in tag +<extra> is displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary box +completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property insidetextanchor¶

Determines if texts are kept at center or start/end points in +textposition “inside” mode.

The ‘insidetextanchor’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘end’, ‘middle’, ‘start’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property insidetextfont¶

Sets the font used for text lying inside the bar.

The ‘insidetextfont’ property is an instance of Insidetextfont +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Insidetextfont
+
A dict of string/value properties that will be passed +to the Insidetextfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Insidetextfont
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.bar.marker.ColorBa +r instance or dict with compatible properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.bar.marker.Line +instance or dict with compatible properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

Shifts the position where the bar is drawn (in position axis +units). In “group” barmode, traces that set “offset” will be +excluded and drawn in “overlay” mode instead.

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property offsetgroup¶

Set several traces linked to the same position axis or matching +axes to the same offsetgroup where bars of the same position +coordinate will line up.

The ‘offsetgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offsetsrc¶

Sets the source reference on Chart Studio Cloud for offset .

The ‘offsetsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property orientation¶

Sets the orientation of the bars. With “v” (“h”), the value of +the each bar spans along the vertical (horizontal).

The ‘orientation’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘v’, ‘h’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property outsidetextfont¶

Sets the font used for text lying outside the bar.

The ‘outsidetextfont’ property is an instance of Outsidetextfont +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Outsidetextfont
+
A dict of string/value properties that will be passed +to the Outsidetextfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Outsidetextfont
+

+ +

+property r¶

r coordinates in scatter traces are deprecated!Please switch to +the “scatterpolar” trace type.Sets the radial coordinatesfor +legacy polar chart only.

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.bar.selected.Marke +r instance or dict with compatible properties
+
+
textfont
plotly.graph_objects.bar.selected.Textf +ont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Stream
+

+ +

+property t¶

t coordinates in scatter traces are deprecated!Please switch to +the “scatterpolar” trace type.Sets the angular coordinatesfor +legacy polar chart only.

The ‘t’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property text¶

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¶

Returns: +
Return type: int|float
+

+ +

+property textfont¶

Sets the font used for text.

The ‘textfont’ property is an instance of Textfont +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Textfont
+
A dict of string/value properties that will be passed +to the Textfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Textfont
+

+ +

+property textposition¶

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¶

The ‘texttemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for +texttemplate .

The ‘texttemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.bar.unselected.Mar +ker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.bar.unselected.Tex +tfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property width¶

Sets the bar width (in position axis units).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property widthsrc¶

Sets the source reference on Chart Studio Cloud for width .

The ‘widthsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Alternate to x. Builds a linear space of x coordinates. Use +with dx where x0 is the starting coordinate and dx the +step.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.Area(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, r=None, rsrc=None, showlegend=None, stream=None, t=None, tsrc=None, uid=None, uirevision=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.area.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.area.Hoverlabel
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.area.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
color
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets themarkercolor. +It accepts either a specific color or an array +of numbers that are mapped to the colorscale +relative to the max and min values of the array +or relative to marker.cmin and marker.cmax +if set.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
opacity
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets the marker +opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
size
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets the marker size +(in px).
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets the marker +symbol type. Adding 100 is equivalent to +appending “-open” to a symbol name. Adding 200 +is equivalent to appending “-dot” to a symbol +name. Adding 300 is equivalent to appending +“-open-dot” or “dot-open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.area.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property r¶

Area traces are deprecated! Please switch to the “barpolar” +trace type. Sets the radial coordinates for legacy polar chart +only.

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.area.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.area.Stream
+

+ +

+property t¶

Area traces are deprecated! Please switch to the “barpolar” +trace type. Sets the angular coordinates for legacy polar chart +only.

The ‘t’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

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(arg=None, angularaxis=None, annotations=None, annotationdefaults=None, autosize=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, datarevision=None, direction=None, dragmode=None, editrevision=None, extendfunnelareacolors=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, images=None, imagedefaults=None, legend=None, mapbox=None, margin=None, meta=None, metasrc=None, modebar=None, orientation=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, radialaxis=None, scene=None, selectdirection=None, selectionrevision=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=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 angularaxis¶

The ‘angularaxis’ property is an instance of AngularAxis +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.AngularAxis
+
A dict of string/value properties that will be passed +to the AngularAxis constructor
+
Supported dict properties:
+
+
+
domain
Polar chart subplots are not supported yet. +This key has currently no effect.
+
+
endpadding
Legacy polar charts are deprecated! Please +switch to “polar” subplots.
+
+
range
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Defines the start +and end point of this angular axis.
+
+
showline
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Determines whether +or not the line bounding this angular axis will +be shown on the figure.
+
+
showticklabels
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Determines whether +or not the angular axis ticks will feature tick +labels.
+
+
tickcolor
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the color of +the tick lines on this angular axis.
+
+
ticklen
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the length of +the tick lines on this angular axis.
+
+
tickorientation
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the +orientation (from the paper perspective) of the +angular axis tick labels.
+
+
ticksuffix
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the length of +the tick lines on this angular axis.
+
+
visible
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Determines whether +or not this axis will be visible.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.AngularAxis
+

+ +

+property annotationdefaults¶

When used in a template (as +layout.template.layout.annotationdefaults), sets the default +property values to use for elements of layout.annotations

The ‘annotationdefaults’ property is an instance of Annotation +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Annotation
+
A dict of string/value properties that will be passed +to the Annotation constructor
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +within the box. Has an effect only if text +spans two or more lines (i.e. text contains +one or more HTML tags) or if an explicit +width is set to override the text width.
+
+
arrowcolor
Sets the color of the annotation arrow.
+
+
arrowhead
Sets the end annotation arrow head style.
+
+
arrowside
Sets the annotation arrow head position.
+
+
arrowsize
Sets the size of the end annotation arrow head, +relative to arrowwidth. A value of 1 +(default) gives a head about 3x as wide as the +line.
+
+
arrowwidth
Sets the width (in px) of annotation arrow +line.
+
+
ax
Sets the x component of the arrow tail about +the arrow head. If axref is pixel, a +positive (negative) component corresponds to +an arrow pointing from right to left (left to +right). If axref is an axis, this is an +absolute value on that axis, like x, NOT a +relative value.
+
+
axref
Indicates in what terms the tail of the +annotation (ax,ay) is specified. If pixel, +ax is a relative offset in pixels from x. +If set to an x axis id (e.g. “x” or “x2”), ax +is specified in the same terms as that axis. +This is useful for trendline annotations which +should continue to indicate the correct trend +when zoomed.
+
+
ay
Sets the y component of the arrow tail about +the arrow head. If ayref is pixel, a +positive (negative) component corresponds to +an arrow pointing from bottom to top (top to +bottom). If ayref is an axis, this is an +absolute value on that axis, like y, NOT a +relative value.
+
+
ayref
Indicates in what terms the tail of the +annotation (ax,ay) is specified. If pixel, +ay is a relative offset in pixels from y. +If set to a y axis id (e.g. “y” or “y2”), ay +is specified in the same terms as that axis. +This is useful for trendline annotations which +should continue to indicate the correct trend +when zoomed.
+
+
bgcolor
Sets the background color of the annotation.
+
+
bordercolor
Sets the color of the border enclosing the +annotation text.
+
+
borderpad
Sets the padding (in px) between the text and +the enclosing border.
+
+
borderwidth
Sets the width (in px) of the border enclosing +the annotation text.
+
+
captureevents
Determines whether the annotation text box +captures mouse move and click events, or allows +those events to pass through to data points in +the plot that may be behind the annotation. By +default captureevents is False unless +hovertext is provided. If you use the event +plotly_clickannotation without hovertext +you must explicitly enable captureevents.
+
+
clicktoshow
Makes this annotation respond to clicks on the +plot. If you click a data point that exactly +matches the x and y values of this +annotation, and it is hidden (visible: false), +it will appear. In “onoff” mode, you must click +the same point again to make it disappear, so +if you click multiple points, you can show +multiple annotations. In “onout” mode, a click +anywhere else in the plot (on another data +point or not) will hide this annotation. If you +need to show/hide this annotation in response +to different x or y values, you can set +xclick and/or yclick. This is useful for +example to label the side of a bar. To label +markers though, standoff is preferred over +xclick and yclick.
+
+
font
Sets the annotation text font.
+
+
height
Sets an explicit height for the text box. null +(default) lets the text set the box height. +Taller text will be clipped.
+
+
hoverlabel
plotly.graph_objects.layout.annotation. +Hoverlabel instance or dict with compatible +properties
+
+
hovertext
Sets text to appear when hovering over this +annotation. If omitted or blank, no hover label +will appear.
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
opacity
Sets the opacity of the annotation (text + +arrow).
+
+
showarrow
Determines whether or not the annotation is +drawn with an arrow. If True, text is placed +near the arrow’s tail. If False, text lines +up with the x and y provided.
+
+
standoff
Sets a distance, in pixels, to move the end +arrowhead away from the position it is pointing +at, for example to point at the edge of a +marker independent of zoom. Note that this +shortens the arrow from the ax / ay vector, +in contrast to xshift / yshift which moves +everything by this amount.
+
+
startarrowhead
Sets the start annotation arrow head style.
+
+
startarrowsize
Sets the size of the start annotation arrow +head, relative to arrowwidth. A value of 1 +(default) gives a head about 3x as wide as the +line.
+
+
startstandoff
Sets a distance, in pixels, to move the start +arrowhead away from the position it is pointing +at, for example to point at the edge of a +marker independent of zoom. Note that this +shortens the arrow from the ax / ay vector, +in contrast to xshift / yshift which moves +everything by this amount.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
text
Sets the text associated with this annotation. +Plotly uses a subset of HTML tags to do things +like newline ( ), bold (), italics +(), hyperlinks (<a href=’…’></a>). +Tags , , are also +supported.
+
+
textangle
Sets the angle at which the text is drawn +with respect to the horizontal.
+
+
valign
Sets the vertical alignment of the text +within the box. Has an effect only if an +explicit height is set to override the text +height.
+
+
visible
Determines whether or not this annotation is +visible.
+
+
width
Sets an explicit width for the text box. null +(default) lets the text set the box width. +Wider text will be clipped. There is no +automatic wrapping; use to start a new +line.
+
+
x
Sets the annotation’s x position. If the axis +type is “log”, then you must take the log of +your desired range. If the axis type is +“date”, it should be date strings, like date +data, though Date objects and unix milliseconds +will be accepted and converted to strings. If +the axis type is “category”, it should be +numbers, using the scale where each category is +assigned a serial number from zero in the order +it appears.
+
+
xanchor
Sets the text box’s horizontal position anchor +This anchor binds the x position to the +“left”, “center” or “right” of the annotation. +For example, if x is set to 1, xref to +“paper” and xanchor to “right” then the +right-most portion of the annotation lines up +with the right-most edge of the plotting area. +If “auto”, the anchor is equivalent to “center” +for data-referenced annotations or if there is +an arrow, whereas for paper-referenced with no +arrow, the anchor picked corresponds to the +closest side.
+
+
xclick
Toggle this annotation when clicking a data +point whose x value is xclick rather than +the annotation’s x value.
+
+
xref
Sets the annotation’s x coordinate axis. If set +to an x axis id (e.g. “x” or “x2”), the x +position refers to an x coordinate If set to +“paper”, the x position refers to the +distance from the left side of the plotting +area in normalized coordinates where 0 (1) +corresponds to the left (right) side.
+
+
xshift
Shifts the position of the whole annotation and +arrow to the right (positive) or left +(negative) by this many pixels.
+
+
y
Sets the annotation’s y position. If the axis +type is “log”, then you must take the log of +your desired range. If the axis type is +“date”, it should be date strings, like date +data, though Date objects and unix milliseconds +will be accepted and converted to strings. If +the axis type is “category”, it should be +numbers, using the scale where each category is +assigned a serial number from zero in the order +it appears.
+
+
yanchor
Sets the text box’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the annotation. +For example, if y is set to 1, yref to +“paper” and yanchor to “top” then the top- +most portion of the annotation lines up with +the top-most edge of the plotting area. If +“auto”, the anchor is equivalent to “middle” +for data-referenced annotations or if there is +an arrow, whereas for paper-referenced with no +arrow, the anchor picked corresponds to the +closest side.
+
+
yclick
Toggle this annotation when clicking a data +point whose y value is yclick rather than +the annotation’s y value.
+
+
yref
Sets the annotation’s y coordinate axis. If set +to an y axis id (e.g. “y” or “y2”), the y +position refers to an y coordinate If set to +“paper”, the y position refers to the +distance from the bottom of the plotting area +in normalized coordinates where 0 (1) +corresponds to the bottom (top).
+
+
yshift
Shifts the position of the whole annotation and +arrow up (positive) or down (negative) by this +many pixels.
+
+
+
+
+
+

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 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 an +“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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property clickmode¶

Determines the mode of single click interactions. “event” is +the default value and emits the plotly_click event. In +addition this mode emits the plotly_selected event in drag +modes “lasso” and “select”, but with no event data attached +(kept for compatibility reasons). The “select” flag enables +selecting single data points via click. This mode also supports +persistent selections, meaning that pressing Shift while +clicking, adds to / subtracts from an existing selection. +“select” with hovermode: “x” can be confusing, consider +explicitly setting hovermode: “closest” when using this +feature. Selection events are sent accordingly as long as +“event” flag is set as well. When the “event” flag is missing, +plotly_click and plotly_selected events are not fired.

The ‘clickmode’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘event’, ‘select’] joined with ‘+’ characters +(e.g. ‘event+select’) +OR exactly one of [‘none’] (e.g. ‘none’)
+
+

Returns: +
Return type: Any
+

+ +

+property coloraxis¶

The ‘coloraxis’ property is an instance of Coloraxis +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Coloraxis
+
A dict of string/value properties that will be passed +to the Coloraxis constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by colorscale. In case +colorscale is unspecified or autocolorscale +is true, the default palette will be chosen +according to whether numbers in the color +array are all positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +corresponding trace color array(s)) or the +bounds set in cmin and cmax Defaults to +false when cmin and cmax are set by the +user.
+
+
cmax
Sets the upper bound of the color domain. Value +should have the same units as corresponding +trace color array(s) and if set, cmin must be +set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling cmin and/or cmax to be equidistant +to this point. Value should have the same units +as corresponding trace color array(s). Has no +effect when cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Value +should have the same units as corresponding +trace color array(s) and if set, cmax must be +set as well.
+
+
colorbar
plotly.graph_objects.layout.coloraxis.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. The colorscale must be an +array containing arrays mapping a normalized +value to an rgb, rgba, hex, hsl, hsv, or named +color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. +For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and +cmax. Alternatively, colorscale may be a +palette name string of the following list: Grey +s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, +Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth +,Electric,Viridis,Cividis.
+
+
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.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Coloraxis
+

+ +

+property colorscale¶

The ‘colorscale’ property is an instance of Colorscale +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Colorscale
+
A dict of string/value properties that will be passed +to the Colorscale constructor
+
Supported dict properties:
+
+
+
diverging
Sets the default diverging colorscale. Note +that autocolorscale must be true for this +attribute to work.
+
+
sequential
Sets the default sequential colorscale for +positive values. Note that autocolorscale +must be true for this attribute to work.
+
+
sequentialminus
Sets the default sequential colorscale for +negative values. Note that autocolorscale +must be true for this attribute to work.
+
+
+
+
+
+

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 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 direction¶

Legacy polar charts are deprecated! Please switch to “polar” +subplots. Sets the direction corresponding to positive angles +in legacy polar charts.

The ‘direction’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘clockwise’, ‘counterclockwise’]
+
+
+

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’, ‘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 extendpiecolors¶

If true, the pie slice colors (whether given by piecolorway +or inherited from colorway) will be extended to three times +its original length by first repeating every color 20% lighter +then each color 20% darker. This is intended to reduce the +likelihood of reusing the same color when you have many slices, +but you can set false to disable. Colors provided in the +trace, using marker.colors, are never extended.

The ‘extendpiecolors’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property extendsunburstcolors¶

If true, the sunburst slice colors (whether given by +sunburstcolorway or inherited from colorway) will be +extended to three times its original length by first repeating +every color 20% lighter then each color 20% darker. This is +intended to reduce the likelihood of reusing the same color +when you have many slices, but you can set false to disable. +Colors provided in the trace, using marker.colors, are never +extended.

The ‘extendsunburstcolors’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property extendtreemapcolors¶

If true, the treemap slice colors (whether given by +treemapcolorway or inherited from colorway) will be +extended to three times its original length by first repeating +every color 20% lighter then each color 20% darker. This is +intended to reduce the likelihood of reusing the same color +when you have many slices, but you can set false to disable. +Colors provided in the trace, using marker.colors, are never +extended.

The ‘extendtreemapcolors’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property font¶

Sets the global font. Note that fonts used in traces and other +layout components inherit from the global font.

The ‘font’ property is an instance of Font +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Font
+
A dict of string/value properties that will be passed +to the Font constructor
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 an “opacity” to see multiple bars.

The ‘funnelmode’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘stack’, ‘group’, ‘overlay’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property geo¶

The ‘geo’ property is an instance of Geo +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Geo
+
A dict of string/value properties that will be passed +to the Geo constructor
+
Supported dict properties:
+
+
+
bgcolor
Set the background color of the map
+
+
center
plotly.graph_objects.layout.geo.Center +instance or dict with compatible properties
+
+
coastlinecolor
Sets the coastline color.
+
+
coastlinewidth
Sets the coastline stroke width (in px).
+
+
countrycolor
Sets line color of the country boundaries.
+
+
countrywidth
Sets line width (in px) of the country +boundaries.
+
+
domain
plotly.graph_objects.layout.geo.Domain +instance or dict with compatible properties
+
+
fitbounds
Determines if this subplot’s view settings are +auto-computed to fit trace data. On scoped +maps, setting fitbounds leads to center.lon +and center.lat getting auto-filled. On maps +with a non-clipped projection, setting +fitbounds leads to center.lon, +center.lat, and projection.rotation.lon +getting auto-filled. On maps with a clipped +projection, setting fitbounds leads to +center.lon, center.lat, +projection.rotation.lon, +projection.rotation.lat, lonaxis.range and +lonaxis.range getting auto-filled. If +“locations”, only the trace’s visible locations +are considered in the fitbounds computations. +If “geojson”, the entire trace input geojson +(if provided) is considered in the fitbounds +computations, Defaults to False.
+
+
framecolor
Sets the color the frame.
+
+
framewidth
Sets the stroke width (in px) of the frame.
+
+
lakecolor
Sets the color of the lakes.
+
+
landcolor
Sets the land mass color.
+
+
lataxis
:class:`plotly.graph_objects.layout.geo.Lataxis +` instance or dict with compatible properties
+
+
lonaxis
:class:`plotly.graph_objects.layout.geo.Lonaxis +` instance or dict with compatible properties
+
+
oceancolor
Sets the ocean color
+
+
projection
plotly.graph_objects.layout.geo.Project +ion instance or dict with compatible +properties
+
+
resolution
Sets the resolution of the base layers. The +values have units of km/mm e.g. 110 corresponds +to a scale ratio of 1:110,000,000.
+
+
rivercolor
Sets color of the rivers.
+
+
riverwidth
Sets the stroke width (in px) of the rivers.
+
+
scope
Set the scope of the map.
+
+
showcoastlines
Sets whether or not the coastlines are drawn.
+
+
showcountries
Sets whether or not country boundaries are +drawn.
+
+
showframe
Sets whether or not a frame is drawn around the +map.
+
+
showlakes
Sets whether or not lakes are drawn.
+
+
showland
Sets whether or not land masses are filled in +color.
+
+
showocean
Sets whether or not oceans are filled in color.
+
+
showrivers
Sets whether or not rivers are drawn.
+
+
showsubunits
Sets whether or not boundaries of subunits +within countries (e.g. states, provinces) are +drawn.
+
+
subunitcolor
Sets the color of the subunits boundaries.
+
+
subunitwidth
Sets the stroke width (in px) of the subunits +boundaries.
+
+
uirevision
Controls persistence of user-driven changes in +the view (projection and center). Defaults to +layout.uirevision.
+
+
visible
Sets the default visibility of the base layers.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Geo
+

+ +

+property grid¶

The ‘grid’ property is an instance of Grid +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Grid
+
A dict of string/value properties that will be passed +to the Grid constructor
+
Supported dict properties:
+
+
+
columns
The number of columns in the grid. If you +provide a 2D subplots array, the length of +its longest row is used as the default. If you +give an xaxes array, its length is used as +the default. But it’s also possible to have a +different length, if you want to leave a row at +the end for non-cartesian subplots.
+
+
domain
:class:`plotly.graph_objects.layout.grid.Domain +` instance or dict with compatible properties
+
+
pattern
If no subplots, xaxes, or yaxes are given +but we do have rows and columns, we can +generate defaults using consecutive axis IDs, +in two ways: “coupled” gives one x axis per +column and one y axis per row. “independent” +uses a new xy pair for each cell, left-to-right +across each row then iterating rows according +to roworder.
+
+
roworder
Is the first row the top or the bottom? Note +that columns are always enumerated from left to +right.
+
+
rows
The number of rows in the grid. If you provide +a 2D subplots array or a yaxes array, its +length is used as the default. But it’s also +possible to have a different length, if you +want to leave a row at the end for non- +cartesian subplots.
+
+
subplots
Used for freeform grids, where some axes may be +shared across subplots but others are not. Each +entry should be a cartesian subplot id, like +“xy” or “x3y2”, or “” to leave that cell empty. +You may reuse x axes within the same column, +and y axes within the same row. Non-cartesian +subplots and traces that support domain can +place themselves in this grid separately using +the gridcell attribute.
+
+
xaxes
Used with yaxes when the x and y axes are +shared across columns and rows. Each entry +should be an x axis id like “x”, “x2”, etc., or +“” to not put an x axis in that column. Entries +other than “” must be unique. Ignored if +subplots is present. If missing but yaxes +is present, will generate consecutive IDs.
+
+
xgap
Horizontal space between grid cells, expressed +as a fraction of the total width available to +one cell. Defaults to 0.1 for coupled-axes +grids and 0.2 for independent grids.
+
+
xside
Sets where the x axis labels and titles go. +“bottom” means the very bottom of the grid. +“bottom plot” is the lowest plot that each x +axis is used in. “top” and “top plot” are +similar.
+
+
yaxes
Used with yaxes when the x and y axes are +shared across columns and rows. Each entry +should be an y axis id like “y”, “y2”, etc., or +“” to not put a y axis in that row. Entries +other than “” must be unique. Ignored if +subplots is present. If missing but xaxes +is present, will generate consecutive IDs.
+
+
ygap
Vertical space between grid cells, expressed as +a fraction of the total height available to one +cell. Defaults to 0.1 for coupled-axes grids +and 0.3 for independent grids.
+
+
yside
Sets where the y axis labels and titles go. +“left” means the very left edge of the grid. +left plot is the leftmost plot that each y +axis is used in. “right” and right plot are +similar.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Grid
+

+ +

+property height¶

Sets the plot’s height (in px).

The ‘height’ property is a number and may be specified as:

An int or float in the interval [10, inf]

Returns: +
Return type: int|float
+

+ +

+property hiddenlabels¶

hiddenlabels is the funnelarea & pie chart analog of +visible:’legendonly’ but it can contain many labels, and can +simultaneously hide slices from several pies/funnelarea charts

The ‘hiddenlabels’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property hiddenlabelssrc¶

Sets the source reference on Chart Studio Cloud for +hiddenlabels .

The ‘hiddenlabelssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hidesources¶

Determines whether or not a text link citing the data source is +placed at the bottom-right cored of the figure. Has only an +effect only on graphs that have been generated via forked +graphs from the Chart Studio Cloud (at https://chart- +studio.plotly.com or on-premise).

The ‘hidesources’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property hoverdistance¶

Sets the default distance (in pixels) to look for data to add +hover labels (-1 means no cutoff, 0 means no looking for data). +This is only a real distance for hovering on point-like +objects, like scatter points. For area-like objects (bars, +scatter fills, etc) hovering is on inside the area and off +outside, but these objects will not supersede hover on point- +like objects in case of conflict.

The ‘hoverdistance’ property is a integer and may be specified as:

An int (or float that will be cast to an int) +in the interval [-1, 9223372036854775807]

Returns: +
Return type: int
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
bgcolor
Sets the background color of all hover labels +on graph
+
+
bordercolor
Sets the border color of all hover labels on +graph.
+
+
font
Sets the default hover label font used by all +traces on the graph.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
+
+
+
+

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. If clickmode includes +the “select” flag, hovermode defaults to “closest”. If +clickmode lacks the “select” flag, it defaults to “x” or “y” +(depending on the trace’s orientation value) for plots based +on cartesian coordinates. For anything else the default value +is “closest”.

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 imagedefaults¶

When used in a template (as +layout.template.layout.imagedefaults), sets the default +property values to use for elements of layout.images

The ‘imagedefaults’ property is an instance of Image +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Image
+
A dict of string/value properties that will be passed +to the Image constructor
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
layer
Specifies whether images are drawn below or +above traces. When xref and yref are both +set to paper, image is drawn below the entire +plot area.
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
opacity
Sets the opacity of the image.
+
+
sizex
Sets the image container size horizontally. The +image will be sized based on the position +value. When xref is set to paper, units are +sized relative to the plot width.
+
+
sizey
Sets the image container size vertically. The +image will be sized based on the position +value. When yref is set to paper, units are +sized relative to the plot height.
+
+
sizing
Specifies which dimension of the image to +constrain.
+
+
source
Specifies the URL of the image to be used. The +URL must be accessible from the domain where +the plot code is run, and can be either +relative or absolute.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
visible
Determines whether or not this image is +visible.
+
+
x
Sets the image’s x position. When xref is set +to paper, units are sized relative to the +plot height. See xref for more info
+
+
xanchor
Sets the anchor for the x position
+
+
xref
Sets the images’s x coordinate axis. If set to +a x axis id (e.g. “x” or “x2”), the x +position refers to an x data coordinate If set +to “paper”, the x position refers to the +distance from the left of plot in normalized +coordinates where 0 (1) corresponds to the left +(right).
+
+
y
Sets the image’s y position. When yref is set +to paper, units are sized relative to the +plot height. See yref for more info
+
+
yanchor
Sets the anchor for the y position.
+
+
yref
Sets the images’s y coordinate axis. If set to +a y axis id (e.g. “y” or “y2”), the y +position refers to a y data coordinate. If set +to “paper”, the y position refers to the +distance from the bottom of the plot in +normalized coordinates where 0 (1) corresponds +to the bottom (top).
+
+
+
+
+
+

Returns: +
Return type: tuple[plotly.graph_objects.layout.Image]
+

+ +

+property legend¶

The ‘legend’ property is an instance of Legend +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Legend
+
A dict of string/value properties that will be passed +to the Legend constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the legend background color. Defaults to +layout.paper_bgcolor.
+
+
bordercolor
Sets the color of the border enclosing the +legend.
+
+
borderwidth
Sets the width (in px) of the border enclosing +the legend.
+
+
font
Sets the font used to text the legend items.
+
+
itemclick
Determines the behavior on legend item click. +“toggle” toggles the visibility of the item +clicked on the graph. “toggleothers” makes the +clicked item the sole visible item on the +graph. False disable legend item click +interactions.
+
+
itemdoubleclick
Determines the behavior on legend item double- +click. “toggle” toggles the visibility of the +item clicked on the graph. “toggleothers” makes +the clicked item the sole visible item on the +graph. False disable legend item double-click +interactions.
+
+
itemsizing
Determines if the legend items symbols scale +with their corresponding “trace” attributes or +remain “constant” independent of the symbol +size on the graph.
+
+
orientation
Sets the orientation of the legend.
+
+
title
plotly.graph_objects.layout.legend.Titl +e instance or dict with compatible properties
+
+
tracegroupgap
Sets the amount of vertical space (in px) +between legend groups.
+
+
traceorder
Determines the order at which the legend items +are displayed. If “normal”, the items are +displayed top-to-bottom in the same order as +the input data. If “reversed”, the items are +displayed in the opposite order as “normal”. If +“grouped”, the items are displayed in groups +(when a trace legendgroup is provided). if +“grouped+reversed”, the items are displayed in +the opposite order as “grouped”.
+
+
uirevision
Controls persistence of legend-driven changes +in trace and pie label visibility. Defaults to +layout.uirevision.
+
+
valign
Sets the vertical alignment of the symbols with +respect to their associated text.
+
+
x
Sets the x position (in normalized coordinates) +of the legend. Defaults to 1.02 for vertical +legends and defaults to 0 for horizontal +legends.
+
+
xanchor
Sets the legend’s horizontal position anchor. +This anchor binds the x position to the +“left”, “center” or “right” of the legend. +Value “auto” anchors legends to the right for +x values greater than or equal to 2/3, +anchors legends to the left for x values less +than or equal to 1/3 and anchors legends with +respect to their center otherwise.
+
+
y
Sets the y position (in normalized coordinates) +of the legend. Defaults to 1 for vertical +legends, defaults to “-0.1” for horizontal +legends on graphs w/o range sliders and +defaults to 1.1 for horizontal legends on graph +with one or multiple range sliders.
+
+
yanchor
Sets the legend’s vertical position anchor This +anchor binds the y position to the “top”, +“middle” or “bottom” of the legend. Value +“auto” anchors legends at their bottom for y +values less than or equal to 1/3, anchors +legends to at their top for y values greater +than or equal to 2/3 and anchors legends with +respect to their middle otherwise.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Legend
+

+ +

+property mapbox¶

The ‘mapbox’ property is an instance of Mapbox +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Mapbox
+
A dict of string/value properties that will be passed +to the Mapbox constructor
+
Supported dict properties:
+
+
+
accesstoken
Sets the mapbox access token to be used for +this mapbox map. Alternatively, the mapbox +access token can be set in the configuration +options under mapboxAccessToken. Note that +accessToken are only required when style (e.g +with values : basic, streets, outdoors, light, +dark, satellite, satellite-streets ) and/or a +layout layer references the Mapbox server.
+
+
bearing
Sets the bearing angle of the map in degrees +counter-clockwise from North (mapbox.bearing).
+
+
center
plotly.graph_objects.layout.mapbox.Cent +er instance or dict with compatible properties
+
+
domain
plotly.graph_objects.layout.mapbox.Doma +in instance or dict with compatible properties
+
+
layers
A tuple of plotly.graph_objects.layout. +mapbox.Layer instances or dicts with +compatible properties
+
+
layerdefaults
When used in a template (as +layout.template.layout.mapbox.layerdefaults), +sets the default property values to use for +elements of layout.mapbox.layers
+
+
pitch
Sets the pitch angle of the map (in degrees, +where 0 means perpendicular to the surface of +the map) (mapbox.pitch).
+
+
style
Defines the map layers that are rendered by +default below the trace layers defined in +data, which are themselves by default +rendered below the layers defined in +layout.mapbox.layers. These layers can be +defined either explicitly as a Mapbox Style +object which can contain multiple layer +definitions that load data from any public or +private Tile Map Service (TMS or XYZ) or Web +Map Service (WMS) or implicitly by using one of +the built-in style objects which use WMSes +which do not require any access tokens, or by +using a default Mapbox style or custom Mapbox +style URL, both of which require a Mapbox +access token Note that Mapbox access token can +be set in the accesstoken attribute or in the +mapboxAccessToken config option. Mapbox +Style objects are of the form described in the +Mapbox GL JS documentation available at +https://docs.mapbox.com/mapbox-gl-js/style-spec +The built-in plotly.js styles objects are: +open-street-map, white-bg, carto-positron, +carto-darkmatter, stamen-terrain, stamen-toner, +stamen-watercolor The built-in Mapbox styles +are: basic, streets, outdoors, light, dark, +satellite, satellite-streets Mapbox style URLs +are of the form: +mapbox://mapbox.mapbox-<name>-<version>
+
+
uirevision
Controls persistence of user-driven changes in +the view: center, zoom, bearing, pitch. +Defaults to layout.uirevision.
+
+
zoom
Sets the zoom level of the map (mapbox.zoom).
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Mapbox
+

+ +

+property margin¶

The ‘margin’ property is an instance of Margin +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Margin
+
A dict of string/value properties that will be passed +to the Margin constructor
+
Supported dict properties:
+
+
+
autoexpand
Turns on/off margin expansion computations. +Legends, colorbars, updatemenus, sliders, axis +rangeselector and rangeslider are allowed to +push the margins by defaults.
+
+
b
Sets the bottom margin (in px).
+
+
l
Sets the left margin (in px).
+
+
pad
Sets the amount of padding (in px) between the +plotting area and the axis lines
+
+
r
Sets the right margin (in px).
+
+
t
Sets the top margin (in px).
+
+
+
+
+
+

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 modebar¶

The ‘modebar’ property is an instance of Modebar +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Modebar
+
A dict of string/value properties that will be passed +to the Modebar constructor
+
Supported dict properties:
+
+
+
activecolor
Sets the color of the active or hovered on +icons in the modebar.
+
+
bgcolor
Sets the background color of the modebar.
+
+
color
Sets the color of the icons in the modebar.
+
+
orientation
Sets the orientation of the modebar.
+
+
uirevision
Controls persistence of user-driven changes +related to the modebar, including hovermode, +dragmode, and showspikes at both the root +level and inside subplots. Defaults to +layout.uirevision.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Modebar
+

+ +

+property orientation¶

Legacy polar charts are deprecated! Please switch to “polar” +subplots. Rotates the entire polar by the given angle in legacy +polar charts.

The ‘orientation’ 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 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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property 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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property polar¶

The ‘polar’ property is an instance of Polar +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Polar
+
A dict of string/value properties that will be passed +to the Polar constructor
+
Supported dict properties:
+
+
+
angularaxis
plotly.graph_objects.layout.polar.Angul +arAxis instance or dict with compatible +properties
+
+
bargap
Sets the gap between bars of adjacent location +coordinates. Values are unitless, they +represent fractions of the minimum difference +in bar positions in the data.
+
+
barmode
Determines how bars at the same location +coordinate are displayed on the graph. With +“stack”, the bars are stacked on top of one +another With “overlay”, the bars are plotted +over one another, you might need to an +“opacity” to see multiple bars.
+
+
bgcolor
Set the background color of the subplot
+
+
domain
plotly.graph_objects.layout.polar.Domai +n instance or dict with compatible properties
+
+
gridshape
Determines if the radial axis grid lines and +angular axis line are drawn as “circular” +sectors or as “linear” (polygon) sectors. Has +an effect only when the angular axis has type +“category”. Note that radialaxis.angle is +snapped to the angle of the closest vertex when +gridshape is “circular” (so that radial axis +scale is the same as the data scale).
+
+
hole
Sets the fraction of the radius to cut out of +the polar subplot.
+
+
radialaxis
plotly.graph_objects.layout.polar.Radia +lAxis instance or dict with compatible +properties
+
+
sector
Sets angular span of this polar subplot with +two angles (in degrees). Sector are assumed to +be spanned in the counterclockwise direction +with 0 corresponding to rightmost limit of the +polar subplot.
+
+
uirevision
Controls persistence of user-driven changes in +axis attributes, if not overridden in the +individual axes. Defaults to +layout.uirevision.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Polar
+

+ +

+property radialaxis¶

The ‘radialaxis’ property is an instance of RadialAxis +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.RadialAxis
+
A dict of string/value properties that will be passed +to the RadialAxis constructor
+
Supported dict properties:
+
+
+
domain
Polar chart subplots are not supported yet. +This key has currently no effect.
+
+
endpadding
Legacy polar charts are deprecated! Please +switch to “polar” subplots.
+
+
orientation
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the +orientation (an angle with respect to the +origin) of the radial axis.
+
+
range
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Defines the start +and end point of this radial axis.
+
+
showline
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Determines whether +or not the line bounding this radial axis will +be shown on the figure.
+
+
showticklabels
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Determines whether +or not the radial axis ticks will feature tick +labels.
+
+
tickcolor
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the color of +the tick lines on this radial axis.
+
+
ticklen
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the length of +the tick lines on this radial axis.
+
+
tickorientation
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the +orientation (from the paper perspective) of the +radial axis tick labels.
+
+
ticksuffix
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Sets the length of +the tick lines on this radial axis.
+
+
visible
Legacy polar charts are deprecated! Please +switch to “polar” subplots. Determines whether +or not this axis will be visible.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.RadialAxis
+

+ +

+re = <module 're' from '/usr/lib/python3.7/re.py'>¶

+ +

+property scene¶

The ‘scene’ property is an instance of Scene +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Scene
+
A dict of string/value properties that will be passed +to the Scene constructor
+
Supported dict properties:
+
+
+
annotations
A tuple of plotly.graph_objects.layout. +scene.Annotation instances or dicts with +compatible properties
+
+
annotationdefaults
When used in a template (as layout.template.lay +out.scene.annotationdefaults), sets the default +property values to use for elements of +layout.scene.annotations
+
+
aspectmode
If “cube”, this scene’s axes are drawn as a +cube, regardless of the axes’ ranges. If +“data”, this scene’s axes are drawn in +proportion with the axes’ ranges. If “manual”, +this scene’s axes are drawn in proportion with +the input of “aspectratio” (the default +behavior if “aspectratio” is provided). If +“auto”, this scene’s axes are drawn using the +results of “data” except when one axis is more +than four times the size of the two others, +where in that case the results of “cube” are +used.
+
+
aspectratio
Sets this scene’s axis aspectratio.
+
+
+
bgcolor
+
+
camera
plotly.graph_objects.layout.scene.Camer +a instance or dict with compatible properties
+
+
domain
plotly.graph_objects.layout.scene.Domai +n instance or dict with compatible properties
+
+
dragmode
Determines the mode of drag interactions for +this scene.
+
+
hovermode
Determines the mode of hover interactions for +this scene.
+
+
uirevision
Controls persistence of user-driven changes in +camera attributes. Defaults to +layout.uirevision.
+
+
xaxis
:class:`plotly.graph_objects.layout.scene.XAxis +` instance or dict with compatible properties
+
+
yaxis
:class:`plotly.graph_objects.layout.scene.YAxis +` instance or dict with compatible properties
+
+
zaxis
:class:`plotly.graph_objects.layout.scene.ZAxis +` instance or dict with compatible properties
+
+
+
+
+
+

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 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 separators¶

Sets the decimal and thousand separators. For example, *. * +puts a ‘.’ before decimals and a space between thousands. In +English locales, dflt is “.,” but other locales may alter this +default.

The ‘separators’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property shapedefaults¶

When used in a template (as +layout.template.layout.shapedefaults), sets the default +property values to use for elements of layout.shapes

The ‘shapedefaults’ property is an instance of Shape +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Shape
+
A dict of string/value properties that will be passed +to the Shape constructor
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
fillcolor
Sets the color filling the shape’s interior.
+
+
layer
Specifies whether shapes are drawn below or +above traces.
+
+
line
plotly.graph_objects.layout.shape.Line +instance or dict with compatible properties
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
opacity
Sets the opacity of the shape.
+
+
path
For type “path” - a valid SVG path with the +pixel values replaced by data values in +xsizemode/ysizemode being “scaled” and +taken unmodified as pixels relative to +xanchor and yanchor in case of “pixel” size +mode. There are a few restrictions / quirks +only absolute instructions, not relative. So +the allowed segments are: M, L, H, V, Q, C, T, +S, and Z arcs (A) are not allowed because +radius rx and ry are relative. In the future we +could consider supporting relative commands, +but we would have to decide on how to handle +date and log axes. Note that even as is, Q and +C Bezier paths that are smooth on linear axes +may not be smooth on log, and vice versa. no +chained “polybezier” commands - specify the +segment type for each one. On category axes, +values are numbers scaled to the serial numbers +of categories because using the categories +themselves there would be no way to describe +fractional positions On data axes: because +space and T are both normal components of path +strings, we can’t use either to separate date +from time parts. Therefore we’ll use underscore +for this purpose: 2015-02-21_13:45:56.789
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
type
Specifies the shape type to be drawn. If +“line”, a line is drawn from (x0,`y0`) to +(x1,`y1`) with respect to the axes’ sizing +mode. If “circle”, a circle is drawn from +((x0`+`x1)/2, (y0`+`y1)/2)) with radius +(|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 +-`y0`)|) with respect to the axes’ sizing mode. +If “rect”, a rectangle is drawn linking +(x0,`y0`), (x1,`y0`), (x1,`y1`), +(x0,`y1`), (x0,`y0`) with respect to the +axes’ sizing mode. If “path”, draw a custom SVG +path using path. with respect to the axes’ +sizing mode.
+
+
visible
Determines whether or not this shape is +visible.
+
+
x0
Sets the shape’s starting x position. See +type and xsizemode for more info.
+
+
x1
Sets the shape’s end x position. See type and +xsizemode for more info.
+
+
xanchor
Only relevant in conjunction with xsizemode +set to “pixel”. Specifies the anchor point on +the x axis to which x0, x1 and x +coordinates within path are relative to. E.g. +useful to attach a pixel sized shape to a +certain data value. No effect when xsizemode +not set to “pixel”.
+
+
xref
Sets the shape’s x coordinate axis. If set to +an x axis id (e.g. “x” or “x2”), the x +position refers to an x coordinate. If set to +“paper”, the x position refers to the +distance from the left side of the plotting +area in normalized coordinates where 0 (1) +corresponds to the left (right) side. If the +axis type is “log”, then you must take the +log of your desired range. If the axis type +is “date”, then you must convert the date to +unix time in milliseconds.
+
+
xsizemode
Sets the shapes’s sizing mode along the x axis. +If set to “scaled”, x0, x1 and x +coordinates within path refer to data values +on the x axis or a fraction of the plot area’s +width (xref set to “paper”). If set to +“pixel”, xanchor specifies the x position in +terms of data or plot fraction but x0, x1 +and x coordinates within path are pixels +relative to xanchor. This way, the shape can +have a fixed width while maintaining a position +relative to data or plot fraction.
+
+
y0
Sets the shape’s starting y position. See +type and ysizemode for more info.
+
+
y1
Sets the shape’s end y position. See type and +ysizemode for more info.
+
+
yanchor
Only relevant in conjunction with ysizemode +set to “pixel”. Specifies the anchor point on +the y axis to which y0, y1 and y +coordinates within path are relative to. E.g. +useful to attach a pixel sized shape to a +certain data value. No effect when ysizemode +not set to “pixel”.
+
+
yref
Sets the annotation’s y coordinate axis. If set +to an y axis id (e.g. “y” or “y2”), the y +position refers to an y coordinate If set to +“paper”, the y position refers to the +distance from the bottom of the plotting area +in normalized coordinates where 0 (1) +corresponds to the bottom (top).
+
+
ysizemode
Sets the shapes’s sizing mode along the y axis. +If set to “scaled”, y0, y1 and y +coordinates within path refer to data values +on the y axis or a fraction of the plot area’s +height (yref set to “paper”). If set to +“pixel”, yanchor specifies the y position in +terms of data or plot fraction but y0, y1 +and y coordinates within path are pixels +relative to yanchor. This way, the shape can +have a fixed height while maintaining a +position relative to data or plot fraction.
+
+
+
+
+
+

Returns: +
Return type: tuple[plotly.graph_objects.layout.Shape]
+

+ +

+property showlegend¶

Determines whether or not a legend is drawn. Default is true +if there is a trace to show and any of these: a) Two or more +traces would by default be shown in the legend. b) One pie +trace is shown in the legend. c) One trace is explicitly given +with showlegend: true.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property sliderdefaults¶

When used in a template (as +layout.template.layout.sliderdefaults), sets the default +property values to use for elements of layout.sliders

The ‘sliderdefaults’ property is an instance of Slider +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Slider
+
A dict of string/value properties that will be passed +to the Slider constructor
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
active
Determines which button (by index starting from +0) is considered active.
+
+
activebgcolor
Sets the background color of the slider grip +while dragging.
+
+
bgcolor
Sets the background color of the slider.
+
+
bordercolor
Sets the color of the border enclosing the +slider.
+
+
borderwidth
Sets the width (in px) of the border enclosing +the slider.
+
+
currentvalue
plotly.graph_objects.layout.slider.Curr +entvalue instance or dict with compatible +properties
+
+
font
Sets the font of the slider step labels.
+
+
len
Sets the length of the slider This measure +excludes the padding of both ends. That is, the +slider’s length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this slider length is set in +units of plot “fraction” or in *pixels. Use +len to set the value.
+
+
minorticklen
Sets the length in pixels of minor step tick +marks
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
pad
Set the padding of the slider component along +each side.
+
+
steps
A tuple of plotly.graph_objects.layout. +slider.Step instances or dicts with compatible +properties
+
+
stepdefaults
When used in a template (as +layout.template.layout.slider.stepdefaults), +sets the default property values to use for +elements of layout.slider.steps
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
tickcolor
Sets the color of the border enclosing the +slider.
+
+
ticklen
Sets the length in pixels of step tick marks
+
+
tickwidth
Sets the tick width (in px).
+
+
transition
plotly.graph_objects.layout.slider.Tran +sition instance or dict with compatible +properties
+
+
visible
Determines whether or not the slider is +visible.
+
+
x
Sets the x position (in normalized coordinates) +of the slider.
+
+
xanchor
Sets the slider’s horizontal position anchor. +This anchor binds the x position to the +“left”, “center” or “right” of the range +selector.
+
+
y
Sets the y position (in normalized coordinates) +of the slider.
+
+
yanchor
Sets the slider’s vertical position anchor This +anchor binds the y position to the “top”, +“middle” or “bottom” of the range selector.
+
+
+
+
+
+

Returns: +
Return type: tuple[plotly.graph_objects.layout.Slider]
+

+ +

+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
+
Supported dict properties:
+
+
+
data
plotly.graph_objects.layout.template.Da +ta instance or dict with compatible properties
+
+
layout
plotly.graph_objects.Layout instance +or dict with compatible properties
+
+
+
+
+
The name of a registered template where current registered templates +are stored in the plotly.io.templates configuration object. The names +of all registered templates can be retrieved with:
+
>>> import plotly.io as pio
+>>> list(pio.templates)  
+['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]
+
+
+
+
A string containing multiple registered template names, joined on ‘+’ +characters (e.g. ‘template1+template2’). In this case the resulting +template is computed by merging together the collection of registered +templates
+
+

Returns: +
Return type: plotly.graph_objects.layout.Template
+

+ +

+property ternary¶

The ‘ternary’ property is an instance of Ternary +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Ternary
+
A dict of string/value properties that will be passed +to the Ternary constructor
+
Supported dict properties:
+
+
+
aaxis
plotly.graph_objects.layout.ternary.Aax +is instance or dict with compatible properties
+
+
baxis
plotly.graph_objects.layout.ternary.Bax +is instance or dict with compatible properties
+
+
bgcolor
Set the background color of the subplot
+
+
caxis
plotly.graph_objects.layout.ternary.Cax +is instance or dict with compatible properties
+
+
domain
plotly.graph_objects.layout.ternary.Dom +ain instance or dict with compatible +properties
+
+
sum
The number each triplet should sum to, and the +maximum range of each axis
+
+
uirevision
Controls persistence of user-driven changes in +axis min and title, if not overridden in +the individual axes. Defaults to +layout.uirevision.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Ternary
+

+ +

+property title¶

The ‘title’ property is an instance of Title +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Title
+
A dict of string/value properties that will be passed +to the Title constructor
+
Supported dict properties:
+
+
+
font
Sets the title font. Note that the title’s font +used to be customized by the now deprecated +titlefont attribute.
+
+
pad
Sets the padding of the title. Each padding +value only applies when the corresponding +xanchor/yanchor value is set accordingly. +E.g. for left padding to take effect, xanchor +must be set to “left”. The same rule applies if +xanchor/yanchor is determined +automatically. Padding is muted if the +respective anchor value is “middle*/*center”.
+
+
text
Sets the plot’s title. Note that before the +existence of title.text, the title’s contents +used to be defined as the title attribute +itself. This behavior has been deprecated.
+
+
x
Sets the x position with respect to xref in +normalized coordinates from 0 (left) to 1 +(right).
+
+
xanchor
Sets the title’s horizontal alignment with +respect to its x position. “left” means that +the title starts at x, “right” means that the +title ends at x and “center” means that the +title’s center is at x. “auto” divides xref +by three and calculates the xanchor value +automatically based on the value of x.
+
+
xref
Sets the container x refers to. “container” +spans the entire width of the plot. “paper” +refers to the width of the plotting area only.
+
+
y
Sets the y position with respect to yref in +normalized coordinates from 0 (bottom) to 1 +(top). “auto” places the baseline of the title +onto the vertical center of the top margin.
+
+
yanchor
Sets the title’s vertical alignment with +respect to its y position. “top” means that the +title’s cap line is at y, “bottom” means that +the title’s baseline is at y and “middle” means +that the title’s midline is at y. “auto” +divides yref by three and calculates the +yanchor value automatically based on the +value of y.
+
+
yref
Sets the container y refers to. “container” +spans the entire height of the plot. “paper” +refers to the height of the plotting area only.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Title
+

+ +

+property titlefont¶

Please use layout.title.font instead. Sets the +title font. Note that the title’s font used to be customized by +the now deprecated titlefont attribute.

The ‘font’ property is an instance of Font +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.title.Font
+
A dict of string/value properties that will be passed +to the Font constructor
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Type: Deprecated
+

+ +

+property transition¶

Sets transition options used during Plotly.react updates.

The ‘transition’ property is an instance of Transition +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Transition
+
A dict of string/value properties that will be passed +to the Transition constructor
+
Supported dict properties:
+
+
+
duration
The duration of the transition, in +milliseconds. If equal to zero, updates are +synchronous.
+
+
easing
The easing function used for the transition
+
+
ordering
Determines whether the figure’s layout or +traces smoothly transitions during updates that +make both traces and layout change.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Transition
+

+ +

+property treemapcolorway¶

Sets the default treemap slice colors. Defaults to the main +colorway used for trace colors. If you specify a new list +here it can still be extended with lighter and darker colors, +see extendtreemapcolors.

The ‘treemapcolorway’ property is a colorlist that may be specified +as a tuple, list, one-dimensional numpy array, or pandas Series of valid +color strings

Returns: +
Return type: list
+

+ +

+property uirevision¶

Used to allow user interactions with the plot to persist after +Plotly.react calls that are unaware of these interactions. If +uirevision is omitted, or if it is given and it changed from +the previous Plotly.react call, the exact new figure is used. +If uirevision is truthy and did NOT change, any attribute +that has been affected by user interactions and did not receive +a different value in the new figure will keep the interaction +value. layout.uirevision attribute serves as the default for +uirevision attributes in various sub-containers. For finer +control you can set these sub-attributes directly. For example, +if your app separately controls the data on the x and y axes +you might set xaxis.uirevision=*time* and +yaxis.uirevision=*cost*. Then if only the y data is changed, +you can update yaxis.uirevision=*quantity* and the y axis +range will reset but the x axis range will retain any user- +driven zoom.

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property uniformtext¶

The ‘uniformtext’ property is an instance of Uniformtext +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Uniformtext
+
A dict of string/value properties that will be passed +to the Uniformtext constructor
+
Supported dict properties:
+
+
+
minsize
Sets the minimum text size between traces of +the same type.
+
+
mode
Determines how the font size for various text +elements are uniformed between each trace type. +If the computed text sizes were smaller than +the minimum size defined by +uniformtext.minsize using “hide” option hides +the text; and using “show” option shows the +text without further downscaling. Please note +that if the size defined by minsize is +greater than the font size defined by trace, +then the minsize is used.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.Uniformtext
+

+ +

+property updatemenudefaults¶

When used in a template (as +layout.template.layout.updatemenudefaults), sets the default +property values to use for elements of layout.updatemenus

The ‘updatemenudefaults’ property is an instance of Updatemenu +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.Updatemenu
+
A dict of string/value properties that will be passed +to the Updatemenu constructor
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
active
Determines which button (by index starting from +0) is considered active.
+
+
bgcolor
Sets the background color of the update menu +buttons.
+
+
bordercolor
Sets the color of the border enclosing the +update menu.
+
+
borderwidth
Sets the width (in px) of the border enclosing +the update menu.
+
+
buttons
A tuple of plotly.graph_objects.layout. +updatemenu.Button instances or dicts with +compatible properties
+
+
buttondefaults
When used in a template (as layout.template.lay +out.updatemenu.buttondefaults), sets the +default property values to use for elements of +layout.updatemenu.buttons
+
+
direction
Determines the direction in which the buttons +are laid out, whether in a dropdown menu or a +row/column of buttons. For left and up, the +buttons will still appear in left-to-right or +top-to-bottom order respectively.
+
+
font
Sets the font of the update menu button text.
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
pad
Sets the padding around the buttons or dropdown +menu.
+
+
showactive
Highlights active dropdown item or active +button if true.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
type
Determines whether the buttons are accessible +via a dropdown menu or whether the buttons are +stacked horizontally or vertically
+
+
visible
Determines whether or not the update menu is +visible.
+
+
x
Sets the x position (in normalized coordinates) +of the update menu.
+
+
xanchor
Sets the update menu’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the range +selector.
+
+
y
Sets the y position (in normalized coordinates) +of the update menu.
+
+
yanchor
Sets the update menu’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the range +selector.
+
+
+
+
+
+

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 an “opacity” to see multiple bars.

The ‘waterfallmode’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘group’, ‘overlay’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property width¶

Sets the plot’s width (in px).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [10, inf]

Returns: +
Return type: int|float
+

+ +

+property xaxis¶

The ‘xaxis’ property is an instance of XAxis +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.XAxis
+
A dict of string/value properties that will be passed +to the XAxis constructor
+
Supported dict properties:
+
+
+
anchor
If set to an opposite-letter axis id (e.g. +x2, y), this axis is bound to the +corresponding opposite-letter axis. If set to +“free”, this axis’ position is determined by +position.
+
+
automargin
Determines whether long tick labels +automatically grow the figure margins.
+
+
autorange
Determines whether or not the range of this +axis is computed in relation to the input data. +See rangemode for more info. If range is +provided, then autorange is set to False.
+
+
calendar
Sets the calendar system to use for range and +tick0 if this is a date axis. This does not +set the calendar for interpreting data on this +axis, that’s specified in the trace or via the +global layout.calendar
+
+
categoryarray
Sets the order in which categories on this axis +appear. Only has an effect if categoryorder +is set to “array”. Used with categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the case of +categorical variables. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray. Set +categoryorder to total ascending or total +descending if order should be determined by +the numerical order of the values. Similarly, +the order can be determined by the min, max, +sum, mean or median of all the values.
+
+
color
Sets default for all colors associated with +this axis all at once: line, font, tick, and +grid colors. Grid color is lightened by +blending this with the plot background +Individual pieces can override this.
+
+
constrain
If this axis needs to be compressed (either due +to its own scaleanchor and scaleratio or +those of the other axis), determines how that +happens: by increasing the “range” (default), +or by decreasing the “domain”.
+
+
constraintoward
If this axis needs to be compressed (either due +to its own scaleanchor and scaleratio or +those of the other axis), determines which +direction we push the originally specified plot +area. Options are “left”, “center” (default), +and “right” for x axes, and “top”, “middle” +(default), and “bottom” for y axes.
+
+
dividercolor
Sets the color of the dividers Only has an +effect on “multicategory” axes.
+
+
dividerwidth
Sets the width (in px) of the dividers Only has +an effect on “multicategory” axes.
+
+
domain
Sets the domain of this axis (in plot +fraction).
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
fixedrange
Determines whether or not this axis is zoom- +able. If true, then zoom is disabled.
+
+
gridcolor
Sets the color of the grid lines.
+
+
gridwidth
Sets the width (in px) of the grid lines.
+
+
hoverformat
Sets the hover text formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
layer
Sets the layer on which this axis is displayed. +If above traces, this axis is displayed above +all the subplot’s traces If below traces, +this axis is displayed below all the subplot’s +traces, but above the grid lines. Useful when +used together with scatter-like traces with +cliponaxis set to False to show markers +and/or text nodes above this axis.
+
+
linecolor
Sets the axis line color.
+
+
linewidth
Sets the width (in px) of the axis line.
+
+
matches
If set to another axis id (e.g. x2, y), the +range of this axis will match the range of the +corresponding axis in data-coordinates space. +Moreover, matching axes share auto-range +values, category lists and histogram auto-bins. +Note that setting axes simultaneously in both a +scaleanchor and a matches constraint is +currently forbidden. Moreover, note that +matching axes must have the same type.
+
+
mirror
Determines if the axis lines or/and ticks are +mirrored to the opposite side of the plotting +area. If True, the axis lines are mirrored. If +“ticks”, the axis lines and ticks are mirrored. +If False, mirroring is disable. If “all”, axis +lines are mirrored on all shared-axes subplots. +If “allticks”, axis lines and ticks are +mirrored on all shared-axes subplots.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
overlaying
If set a same-letter axis id, this axis is +overlaid on top of the corresponding same- +letter axis, with traces and axes visible for +both axes. If False, this axis does not overlay +any same-letter axes. In this case, for axes +with overlapping domains only the highest- +numbered axis will be visible.
+
+
position
Sets the position of this axis in the plotting +space (in normalized coordinates). Only has an +effect if anchor is set to “free”.
+
+
range
Sets the range of this axis. If the axis type +is “log”, then you must take the log of your +desired range (e.g. to set the range from 1 to +100, set the range from 0 to 2). If the axis +type is “date”, it should be date strings, +like date data, though Date objects and unix +milliseconds will be accepted and converted to +strings. If the axis type is “category”, it +should be numbers, using the scale where each +category is assigned a serial number from zero +in the order it appears.
+
+
rangebreaks
A tuple of plotly.graph_objects.layout. +xaxis.Rangebreak instances or dicts with +compatible properties
+
+
rangebreakdefaults
When used in a template (as layout.template.lay +out.xaxis.rangebreakdefaults), sets the default +property values to use for elements of +layout.xaxis.rangebreaks
+
+
rangemode
If “normal”, the range is computed in relation +to the extrema of the input data. If *tozero*`, +the range extends to 0, regardless of the input +data If “nonnegative”, the range is non- +negative, regardless of the input data. Applies +only to linear axes.
+
+
rangeselector
plotly.graph_objects.layout.xaxis.Range +selector instance or dict with compatible +properties
+
+
rangeslider
plotly.graph_objects.layout.xaxis.Range +slider instance or dict with compatible +properties
+
+
scaleanchor
If set to another axis id (e.g. x2, y), the +range of this axis changes together with the +range of the corresponding axis such that the +scale of pixels per unit is in a constant +ratio. Both axes are still zoomable, but when +you zoom one, the other will zoom the same +amount, keeping a fixed midpoint. constrain +and constraintoward determine how we enforce +the constraint. You can chain these, ie yaxis: +{scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} +but you can only link axes of the same type. +The linked axis can have the opposite letter +(to constrain the aspect ratio) or the same +letter (to match scales across subplots). Loops +(yaxis: {scaleanchor: *x*}, xaxis: +{scaleanchor: *y*} or longer) are redundant +and the last constraint encountered will be +ignored to avoid possible inconsistent +constraints via scaleratio. Note that setting +axes simultaneously in both a scaleanchor and +a matches constraint is currently forbidden.
+
+
scaleratio
If this axis is linked to another by +scaleanchor, this determines the pixel to +unit scale ratio. For example, if this value is +10, then every unit on this axis spans 10 times +the number of pixels as a unit on the linked +axis. Use this for example to create an +elevation profile where the vertical scale is +exaggerated a fixed amount with respect to the +horizontal.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showdividers
Determines whether or not a dividers are drawn +between the category levels of this axis. Only +has an effect on “multicategory” axes.
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showgrid
Determines whether or not grid lines are drawn. +If True, the grid lines are drawn at every tick +mark.
+
+
showline
Determines whether or not a line bounding this +axis is drawn.
+
+
showspikes
Determines whether or not spikes (aka +droplines) are drawn for this axis. Note: This +only takes affect when hovermode = closest
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
side
Determines whether a x (y) axis is positioned +at the “bottom” (“left”) or “top” (“right”) of +the plotting area.
+
+
spikecolor
Sets the spike color. If undefined, will use +the series color
+
+
spikedash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
spikemode
Determines the drawing mode for the spike line +If “toaxis”, the line is drawn from the data +point to the axis the series is plotted on. If +“across”, the line is drawn across the entire +plot area, and supercedes “toaxis”. If +“marker”, then a marker dot is drawn on the +axis the series is plotted on
+
+
spikesnap
Determines whether spikelines are stuck to the +cursor or to the closest datapoints.
+
+
spikethickness
Sets the width (in px) of the zero line.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the tick font.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.layout. +xaxis.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.lay +out.xaxis.tickformatstopdefaults), sets the +default property values to use for elements of +layout.xaxis.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
tickson
Determines where ticks and grid lines are drawn +with respect to their corresponding tick +labels. Only has an effect for axes of type +“category” or “multicategory”. When set to +“boundaries”, ticks and grid lines are drawn +half a category to the left/bottom of labels.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
:class:`plotly.graph_objects.layout.xaxis.Title +` instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use layout.xaxis.title.font +instead. Sets this axis’ title font. Note that +the title’s font used to be customized by the +now deprecated titlefont attribute.
+
+
type
Sets the axis type. By default, plotly attempts +to determined the axis type by looking into the +data of the traces that referenced the axis in +question.
+
+
uirevision
Controls persistence of user-driven changes in +axis range, autorange, and title if in +editable: true configuration. Defaults to +layout.uirevision.
+
+
visible
A single toggle to hide the axis while +preserving interaction like dragging. Default +is true when a cheater plot is present on the +axis, otherwise false
+
+
zeroline
Determines whether or not a line is drawn at +along the 0 value of this axis. If True, the +zero line is drawn on top of the grid lines.
+
+
zerolinecolor
Sets the line color of the zero line.
+
+
zerolinewidth
Sets the width (in px) of the zero line.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.XAxis
+

+ +

+property yaxis¶

The ‘yaxis’ property is an instance of YAxis +that may be specified as:

+
+
An instance of plotly.graph_objects.layout.YAxis
+
A dict of string/value properties that will be passed +to the YAxis constructor
+
Supported dict properties:
+
+
+
anchor
If set to an opposite-letter axis id (e.g. +x2, y), this axis is bound to the +corresponding opposite-letter axis. If set to +“free”, this axis’ position is determined by +position.
+
+
automargin
Determines whether long tick labels +automatically grow the figure margins.
+
+
autorange
Determines whether or not the range of this +axis is computed in relation to the input data. +See rangemode for more info. If range is +provided, then autorange is set to False.
+
+
calendar
Sets the calendar system to use for range and +tick0 if this is a date axis. This does not +set the calendar for interpreting data on this +axis, that’s specified in the trace or via the +global layout.calendar
+
+
categoryarray
Sets the order in which categories on this axis +appear. Only has an effect if categoryorder +is set to “array”. Used with categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the case of +categorical variables. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray. Set +categoryorder to total ascending or total +descending if order should be determined by +the numerical order of the values. Similarly, +the order can be determined by the min, max, +sum, mean or median of all the values.
+
+
color
Sets default for all colors associated with +this axis all at once: line, font, tick, and +grid colors. Grid color is lightened by +blending this with the plot background +Individual pieces can override this.
+
+
constrain
If this axis needs to be compressed (either due +to its own scaleanchor and scaleratio or +those of the other axis), determines how that +happens: by increasing the “range” (default), +or by decreasing the “domain”.
+
+
constraintoward
If this axis needs to be compressed (either due +to its own scaleanchor and scaleratio or +those of the other axis), determines which +direction we push the originally specified plot +area. Options are “left”, “center” (default), +and “right” for x axes, and “top”, “middle” +(default), and “bottom” for y axes.
+
+
dividercolor
Sets the color of the dividers Only has an +effect on “multicategory” axes.
+
+
dividerwidth
Sets the width (in px) of the dividers Only has +an effect on “multicategory” axes.
+
+
domain
Sets the domain of this axis (in plot +fraction).
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
fixedrange
Determines whether or not this axis is zoom- +able. If true, then zoom is disabled.
+
+
gridcolor
Sets the color of the grid lines.
+
+
gridwidth
Sets the width (in px) of the grid lines.
+
+
hoverformat
Sets the hover text formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
layer
Sets the layer on which this axis is displayed. +If above traces, this axis is displayed above +all the subplot’s traces If below traces, +this axis is displayed below all the subplot’s +traces, but above the grid lines. Useful when +used together with scatter-like traces with +cliponaxis set to False to show markers +and/or text nodes above this axis.
+
+
linecolor
Sets the axis line color.
+
+
linewidth
Sets the width (in px) of the axis line.
+
+
matches
If set to another axis id (e.g. x2, y), the +range of this axis will match the range of the +corresponding axis in data-coordinates space. +Moreover, matching axes share auto-range +values, category lists and histogram auto-bins. +Note that setting axes simultaneously in both a +scaleanchor and a matches constraint is +currently forbidden. Moreover, note that +matching axes must have the same type.
+
+
mirror
Determines if the axis lines or/and ticks are +mirrored to the opposite side of the plotting +area. If True, the axis lines are mirrored. If +“ticks”, the axis lines and ticks are mirrored. +If False, mirroring is disable. If “all”, axis +lines are mirrored on all shared-axes subplots. +If “allticks”, axis lines and ticks are +mirrored on all shared-axes subplots.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
overlaying
If set a same-letter axis id, this axis is +overlaid on top of the corresponding same- +letter axis, with traces and axes visible for +both axes. If False, this axis does not overlay +any same-letter axes. In this case, for axes +with overlapping domains only the highest- +numbered axis will be visible.
+
+
position
Sets the position of this axis in the plotting +space (in normalized coordinates). Only has an +effect if anchor is set to “free”.
+
+
range
Sets the range of this axis. If the axis type +is “log”, then you must take the log of your +desired range (e.g. to set the range from 1 to +100, set the range from 0 to 2). If the axis +type is “date”, it should be date strings, +like date data, though Date objects and unix +milliseconds will be accepted and converted to +strings. If the axis type is “category”, it +should be numbers, using the scale where each +category is assigned a serial number from zero +in the order it appears.
+
+
rangebreaks
A tuple of plotly.graph_objects.layout. +yaxis.Rangebreak instances or dicts with +compatible properties
+
+
rangebreakdefaults
When used in a template (as layout.template.lay +out.yaxis.rangebreakdefaults), sets the default +property values to use for elements of +layout.yaxis.rangebreaks
+
+
rangemode
If “normal”, the range is computed in relation +to the extrema of the input data. If *tozero*`, +the range extends to 0, regardless of the input +data If “nonnegative”, the range is non- +negative, regardless of the input data. Applies +only to linear axes.
+
+
scaleanchor
If set to another axis id (e.g. x2, y), the +range of this axis changes together with the +range of the corresponding axis such that the +scale of pixels per unit is in a constant +ratio. Both axes are still zoomable, but when +you zoom one, the other will zoom the same +amount, keeping a fixed midpoint. constrain +and constraintoward determine how we enforce +the constraint. You can chain these, ie yaxis: +{scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} +but you can only link axes of the same type. +The linked axis can have the opposite letter +(to constrain the aspect ratio) or the same +letter (to match scales across subplots). Loops +(yaxis: {scaleanchor: *x*}, xaxis: +{scaleanchor: *y*} or longer) are redundant +and the last constraint encountered will be +ignored to avoid possible inconsistent +constraints via scaleratio. Note that setting +axes simultaneously in both a scaleanchor and +a matches constraint is currently forbidden.
+
+
scaleratio
If this axis is linked to another by +scaleanchor, this determines the pixel to +unit scale ratio. For example, if this value is +10, then every unit on this axis spans 10 times +the number of pixels as a unit on the linked +axis. Use this for example to create an +elevation profile where the vertical scale is +exaggerated a fixed amount with respect to the +horizontal.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showdividers
Determines whether or not a dividers are drawn +between the category levels of this axis. Only +has an effect on “multicategory” axes.
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showgrid
Determines whether or not grid lines are drawn. +If True, the grid lines are drawn at every tick +mark.
+
+
showline
Determines whether or not a line bounding this +axis is drawn.
+
+
showspikes
Determines whether or not spikes (aka +droplines) are drawn for this axis. Note: This +only takes affect when hovermode = closest
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
side
Determines whether a x (y) axis is positioned +at the “bottom” (“left”) or “top” (“right”) of +the plotting area.
+
+
spikecolor
Sets the spike color. If undefined, will use +the series color
+
+
spikedash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
spikemode
Determines the drawing mode for the spike line +If “toaxis”, the line is drawn from the data +point to the axis the series is plotted on. If +“across”, the line is drawn across the entire +plot area, and supercedes “toaxis”. If +“marker”, then a marker dot is drawn on the +axis the series is plotted on
+
+
spikesnap
Determines whether spikelines are stuck to the +cursor or to the closest datapoints.
+
+
spikethickness
Sets the width (in px) of the zero line.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the tick font.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.layout. +yaxis.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.lay +out.yaxis.tickformatstopdefaults), sets the +default property values to use for elements of +layout.yaxis.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
tickson
Determines where ticks and grid lines are drawn +with respect to their corresponding tick +labels. Only has an effect for axes of type +“category” or “multicategory”. When set to +“boundaries”, ticks and grid lines are drawn +half a category to the left/bottom of labels.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
:class:`plotly.graph_objects.layout.yaxis.Title +` instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use layout.yaxis.title.font +instead. Sets this axis’ title font. Note that +the title’s font used to be customized by the +now deprecated titlefont attribute.
+
+
type
Sets the axis type. By default, plotly attempts +to determined the axis type by looking into the +data of the traces that referenced the axis in +question.
+
+
uirevision
Controls persistence of user-driven changes in +axis range, autorange, and title if in +editable: true configuration. Defaults to +layout.uirevision.
+
+
visible
A single toggle to hide the axis while +preserving interaction like dragging. Default +is true when a cheater plot is present on the +axis, otherwise false
+
+
zeroline
Determines whether or not a line is drawn at +along the 0 value of this axis. If True, the +zero line is drawn on top of the grid lines.
+
+
zerolinecolor
Sets the line color of the zero line.
+
+
zerolinewidth
Sets the width (in px) of the zero line.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.layout.YAxis
+

+ +

+class plotly.graph_objects.Frame(arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseFrameHierarchyType

+property baseframe¶

The name of the frame into which this frame’s properties are +merged before applying. This is used to unify properties and +avoid needing to specify the same values for the same +properties in multiple frames.

The ‘baseframe’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property data¶

A list of traces this frame modifies. The format is identical +to the normal trace definition.

Returns: +
Return type: Any
+

+ +

+property group¶

An identifier that specifies the group to which the frame +belongs, used by animate to select a subset of frames.

The ‘group’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property layout¶

Layout properties which this frame modifies. The format is +identical to the normal layout definition.

Returns: +
Return type: Any
+

+ +

+property name¶

A label by which to identify the frame

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property traces¶

A list of trace indices that identify the respective traces in +the data attribute

The ‘traces’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+class plotly.graph_objects.Figure(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)¶

Bases: plotly.basedatatypes.BaseFigure

+add_annotation(arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, row=None, col=None, secondary_y=None, **kwargs)¶

Create and add a new annotation to the figure’s layout

Parameters

arg – instance of Annotation or dict with compatible +properties
align – Sets the horizontal alignment of the text within the +box. Has an effect only if text spans two or more +lines (i.e. text contains one or more HTML tags) +or if an explicit width is set to override the text +width.
arrowcolor – Sets the color of the annotation arrow.
arrowhead – Sets the end annotation arrow head style.
arrowside – Sets the annotation arrow head position.
arrowsize – Sets the size of the end annotation arrow head, +relative to arrowwidth. A value of 1 (default) gives +a head about 3x as wide as the line.
arrowwidth – Sets the width (in px) of annotation arrow line.
ax – Sets the x component of the arrow tail about the arrow +head. If axref is pixel, a positive (negative) +component corresponds to an arrow pointing from right +to left (left to right). If axref is an axis, this is +an absolute value on that axis, like x, NOT a +relative value.
axref – Indicates in what terms the tail of the annotation +(ax,ay) is specified. If pixel, ax is a relative +offset in pixels from x. If set to an x axis id +(e.g. “x” or “x2”), ax is specified in the same +terms as that axis. This is useful for trendline +annotations which should continue to indicate the +correct trend when zoomed.
ay – Sets the y component of the arrow tail about the arrow +head. If ayref is pixel, a positive (negative) +component corresponds to an arrow pointing from bottom +to top (top to bottom). If ayref is an axis, this is +an absolute value on that axis, like y, NOT a +relative value.
ayref – Indicates in what terms the tail of the annotation +(ax,ay) is specified. If pixel, ay is a relative +offset in pixels from y. If set to a y axis id (e.g. +“y” or “y2”), ay is specified in the same terms as +that axis. This is useful for trendline annotations +which should continue to indicate the correct trend +when zoomed.
bgcolor – Sets the background color of the annotation.
bordercolor – Sets the color of the border enclosing the annotation +text.
borderpad – Sets the padding (in px) between the text and the +enclosing border.
borderwidth – Sets the width (in px) of the border enclosing the +annotation text.
captureevents – Determines whether the annotation text box captures +mouse move and click events, or allows those events to +pass through to data points in the plot that may be +behind the annotation. By default captureevents is +False unless hovertext is provided. If you use the +event plotly_clickannotation without hovertext you +must explicitly enable captureevents.
clicktoshow – Makes this annotation respond to clicks on the plot. If +you click a data point that exactly matches the x and +y values of this annotation, and it is hidden +(visible: false), it will appear. In “onoff” mode, you +must click the same point again to make it disappear, +so if you click multiple points, you can show multiple +annotations. In “onout” mode, a click anywhere else in +the plot (on another data point or not) will hide this +annotation. If you need to show/hide this annotation in +response to different x or y values, you can set +xclick and/or yclick. This is useful for example to +label the side of a bar. To label markers though, +standoff is preferred over xclick and yclick.
font – Sets the annotation text font.
height – Sets an explicit height for the text box. null +(default) lets the text set the box height. Taller text +will be clipped.
hoverlabel – plotly.graph_objects.layout.annotation.Hoverlab +el instance or dict with compatible properties
hovertext – Sets text to appear when hovering over this annotation. +If omitted or blank, no hover label will appear.
name – When used in a template, named items are created in the +output figure in addition to any items the figure +already has in this array. You can modify these items +in the output figure by making your own item with +templateitemname matching this name alongside your +modifications (including visible: false or enabled: +false to hide it). Has no effect outside of a +template.
opacity – Sets the opacity of the annotation (text + arrow).
showarrow – Determines whether or not the annotation is drawn with +an arrow. If True, text is placed near the arrow’s +tail. If False, text lines up with the x and y +provided.
standoff – Sets a distance, in pixels, to move the end arrowhead +away from the position it is pointing at, for example +to point at the edge of a marker independent of zoom. +Note that this shortens the arrow from the ax / ay +vector, in contrast to xshift / yshift which moves +everything by this amount.
startarrowhead – Sets the start annotation arrow head style.
startarrowsize – Sets the size of the start annotation arrow head, +relative to arrowwidth. A value of 1 (default) gives +a head about 3x as wide as the line.
startstandoff – Sets a distance, in pixels, to move the start arrowhead +away from the position it is pointing at, for example +to point at the edge of a marker independent of zoom. +Note that this shortens the arrow from the ax / ay +vector, in contrast to xshift / yshift which moves +everything by this amount.
templateitemname – Used to refer to a named item in this array in the +template. Named items from the template will be created +even without a matching item in the input figure, but +you can modify one by making an item with +templateitemname matching its name, alongside your +modifications (including visible: false or enabled: +false to hide it). If there is no template or no +matching item, this item will be hidden unless you +explicitly show it with visible: true.
text – Sets the text associated with this annotation. Plotly +uses a subset of HTML tags to do things like newline +( ), bold (), italics (), hyperlinks +(<a href=’…’></a>). Tags , , +are also supported.
textangle – Sets the angle at which the text is drawn with +respect to the horizontal.
valign – Sets the vertical alignment of the text within the +box. Has an effect only if an explicit height is set to +override the text height.
visible – Determines whether or not this annotation is visible.
width – Sets an explicit width for the text box. null (default) +lets the text set the box width. Wider text will be +clipped. There is no automatic wrapping; use to +start a new line.
x – Sets the annotation’s x position. If the axis type is +“log”, then you must take the log of your desired +range. If the axis type is “date”, it should be date +strings, like date data, though Date objects and unix +milliseconds will be accepted and converted to strings. +If the axis type is “category”, it should be numbers, +using the scale where each category is assigned a +serial number from zero in the order it appears.
xanchor – Sets the text box’s horizontal position anchor This +anchor binds the x position to the “left”, “center” +or “right” of the annotation. For example, if x is +set to 1, xref to “paper” and xanchor to “right” +then the right-most portion of the annotation lines up +with the right-most edge of the plotting area. If +“auto”, the anchor is equivalent to “center” for data- +referenced annotations or if there is an arrow, whereas +for paper-referenced with no arrow, the anchor picked +corresponds to the closest side.
xclick – Toggle this annotation when clicking a data point whose +x value is xclick rather than the annotation’s x +value.
xref – Sets the annotation’s x coordinate axis. If set to an x +axis id (e.g. “x” or “x2”), the x position refers to +an x coordinate If set to “paper”, the x position +refers to the distance from the left side of the +plotting area in normalized coordinates where 0 (1) +corresponds to the left (right) side.
xshift – Shifts the position of the whole annotation and arrow +to the right (positive) or left (negative) by this many +pixels.
y – Sets the annotation’s y position. If the axis type is +“log”, then you must take the log of your desired +range. If the axis type is “date”, it should be date +strings, like date data, though Date objects and unix +milliseconds will be accepted and converted to strings. +If the axis type is “category”, it should be numbers, +using the scale where each category is assigned a +serial number from zero in the order it appears.
yanchor – Sets the text box’s vertical position anchor This +anchor binds the y position to the “top”, “middle” or +“bottom” of the annotation. For example, if y is set +to 1, yref to “paper” and yanchor to “top” then the +top-most portion of the annotation lines up with the +top-most edge of the plotting area. If “auto”, the +anchor is equivalent to “middle” for data-referenced +annotations or if there is an arrow, whereas for paper- +referenced with no arrow, the anchor picked corresponds +to the closest side.
yclick – Toggle this annotation when clicking a data point whose +y value is yclick rather than the annotation’s y +value.
yref – Sets the annotation’s y coordinate axis. If set to an y +axis id (e.g. “y” or “y2”), the y position refers to +an y coordinate If set to “paper”, the y position +refers to the distance from the bottom of the plotting +area in normalized coordinates where 0 (1) corresponds +to the bottom (top).
yshift – Shifts the position of the whole annotation and arrow +up (positive) or down (negative) by this many pixels.
row – Subplot row for annotation
col – Subplot column for annotation
secondary_y – Whether to add annotation to secondary y-axis

Returns

Return type

Figure

+ +

+add_area(customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, r=None, rsrc=None, showlegend=None, stream=None, t=None, tsrc=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Area trace

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.area.Hoverlabel instance +or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.area.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
r – Area traces are deprecated! Please switch to the +“barpolar” trace type. Sets the radial coordinates for +legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.area.Stream instance or +dict with compatible properties
t – Area traces are deprecated! Please switch to the +“barpolar” trace type. Sets the angular coordinates for +legacy polar chart only.
tsrc – Sets the source reference on Chart Studio Cloud for t +.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_bar(alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, t=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Bar trace

The data visualized by the span of the bars is set in y if +orientation is set th “v” (the default) and the labels are +set in x. By setting orientation to “h”, the roles are +interchanged.

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
base – Sets where the bar base is drawn (in position axis +units). In “stack” or “relative” barmode, traces that +set “base” will be excluded and drawn in “overlay” mode +instead.
basesrc – Sets the source reference on Chart Studio Cloud for +base .
cliponaxis – Determines whether the text nodes are clipped about the +subplot axes. To show the text nodes above axis lines +and tick labels, make sure to set xaxis.layer and +yaxis.layer to below traces.
constraintext – Constrain the size of text inside or outside a bar to +be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.bar.ErrorX instance or +dict with compatible properties
error_y – plotly.graph_objects.bar.ErrorY instance or +dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.bar.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables value and label. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextanchor – Determines if texts are kept at center or start/end +points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.bar.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the position where the bar is drawn (in position +axis units). In “group” barmode, traces that set +“offset” will be excluded and drawn in “overlay” mode +instead.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
offsetsrc – Sets the source reference on Chart Studio Cloud for +offset .
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the +value of the each bar spans along the vertical +(horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
r – r coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the radial +coordinatesfor legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.bar.Selected instance or +dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.bar.Stream instance or +dict with compatible properties
t – t coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the +angular coordinatesfor legacy polar chart only.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textangle – Sets the angle of the tick labels with respect to the +bar. For example, a tickangle of -90 draws the tick +labels vertically. With “auto” the texts may +automatically be rotated to fit with the maximum size +in bars.
textfont – Sets the font used for text.
textposition – Specifies the location of the text. “inside” +positions text inside, next to the bar end (rotated +and scaled if needed). “outside” positions text +outside, next to the bar end (scaled if needed), unless +there is another bar stacked on this one, then the text +gets pushed inside. “auto” tries to position text +inside the bar, but if the bar is too small and no bar +is stacked on this one the text is moved outside.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables value and +label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
tsrc – Sets the source reference on Chart Studio Cloud for t +.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.bar.Unselected instance +or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar width (in position axis units).
widthsrc – Sets the source reference on Chart Studio Cloud for +width .
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_barpolar(base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs)¶

Add a new Barpolar trace

The data visualized by the radial span of the bars is set in +r

Parameters

base – Sets where the bar base is drawn (in radial axis +units). In “stack” barmode, traces that set “base” will +be excluded and drawn in “overlay” mode instead.
basesrc – Sets the source reference on Chart Studio Cloud for +base .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the +dtheta step equals the subplot’s period divided by +the length of the r coordinates.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.barpolar.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.barpolar.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the angular position where the bar is drawn (in +“thetatunit” units).
offsetsrc – Sets the source reference on Chart Studio Cloud for +offset .
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r +coordinates. Use with dr where r0 is the starting +coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.barpolar.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.barpolar.Stream instance +or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a polar subplot. If “polar” (the default value), +the data refer to layout.polar. If “polar2”, the data +refer to layout.polar2, and so on.
text – Sets hover text elements associated with each bar. If a +single string, the same string appears over all bars. +If an array of string, the items are mapped in order to +the this trace’s coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the +starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for +theta .
thetaunit – Sets the unit of input “theta” values. Has an effect +only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.barpolar.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar angular width (in “thetaunit” units).
widthsrc – Sets the source reference on Chart Studio Cloud for +width .
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_box(alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legendgroup=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Box trace

Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The +second quartile (Q2, i.e. the median) is marked by a line +inside the box. The fences grow outward from the boxes’ edges, +by default they span +/- 1.5 times the interquartile range +(IQR: Q3-Q1), The sample mean and standard deviation as well as +notches and the sample, outlier and suspected outliers points +can be optionally added to the box plot. The values and +positions corresponding to each boxes can be input using two +signatures. The first signature expects users to supply the +sample values in the y data array for vertical boxes (x for +horizontal boxes). By supplying an x (y) array, one box per +distinct x (y) value is drawn If no x (y) list is +provided, a single box is drawn. In this case, the box is +positioned with the trace name or with x0 (y0) if +provided. The second signature expects users to supply the +boxes corresponding Q1, median and Q3 statistics in the q1, +median and q3 data arrays respectively. Other box features +relying on statistics namely lowerfence, upperfence, +notchspan can be set directly by the users. To have plotly +compute them or to show sample points besides the boxes, users +can set the y data array for vertical boxes (x for +horizontal boxes) to a 2D array with the outer length +corresponding to the number of boxes in the traces and the +inner length corresponding the sample size.

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
boxmean – If True, the mean of the box(es)’ underlying +distribution is drawn as a dashed line inside the +box(es). If “sd” the standard deviation is also drawn. +Defaults to True when mean is set. Defaults to “sd” +when sd is set Otherwise defaults to False.
boxpoints – If “outliers”, only the sample points lying outside the +whiskers are shown If “suspectedoutliers”, the outlier +points are shown and points either less than 4*Q1-3*Q3 +or greater than 4*Q3-3*Q1 are highlighted (see +outliercolor) If “all”, all sample points are shown +If False, only the box(es) are shown with no sample +points Defaults to “suspectedoutliers” when +marker.outliercolor or marker.line.outliercolor is +set. Defaults to “all” under the q1/median/q3 +signature. Otherwise defaults to “outliers”.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step for multi-box traces set +using q1/median/q3.
dy – Sets the y coordinate step for multi-box traces set +using q1/median/q3.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.box.Hoverlabel instance +or dict with compatible properties
hoveron – Do the hover effects highlight individual boxes or +sample points or both?
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
jitter – Sets the amount of jitter in the sample points drawn. +If 0, the sample points align along the distribution +axis. If 1, the sample points are drawn in a random +jitter of width equal to the width of the box(es).
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.box.Line instance or dict +with compatible properties
lowerfence – Sets the lower fence values. There should be as many +items as the number of boxes desired. This attribute +has effect only under the q1/median/q3 signature. If +lowerfence is not provided but a sample (in y or +x) is set, we compute the lower as the last sample +point below 1.5 times the IQR.
lowerfencesrc – Sets the source reference on Chart Studio Cloud for +lowerfence .
marker – plotly.graph_objects.box.Marker instance or +dict with compatible properties
mean – Sets the mean values. There should be as many items as +the number of boxes desired. This attribute has effect +only under the q1/median/q3 signature. If mean is not +provided but a sample (in y or x) is set, we +compute the mean for each box using the sample values.
meansrc – Sets the source reference on Chart Studio Cloud for +mean .
median – Sets the median values. There should be as many items +as the number of boxes desired.
mediansrc – Sets the source reference on Chart Studio Cloud for +median .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover. For box traces, the name will +also be used for the position coordinate, if x and +x0 (y and y0 if horizontal) are missing and the +position axis is categorical
notched – Determines whether or not notches are drawn. Notches +displays a confidence interval around the median. We +compute the confidence interval as median +/- 1.57 * +IQR / sqrt(N), where IQR is the interquartile range and +N is the sample size. If two boxes’ notches do not +overlap there is 95% confidence their medians differ. +See https://sites.google.com/site/davidsstatistics/home +/notched-box-plots for more info. Defaults to False +unless notchwidth or notchspan is set.
notchspan – Sets the notch span from the boxes’ median values. +There should be as many items as the number of boxes +desired. This attribute has effect only under the +q1/median/q3 signature. If notchspan is not provided +but a sample (in y or x) is set, we compute it as +1.57 * IQR / sqrt(N), where N is the sample size.
notchspansrc – Sets the source reference on Chart Studio Cloud for +notchspan .
notchwidth – Sets the width of the notches relative to the box’ +width. For example, with 0, the notches are as wide as +the box(es).
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the box(es). If “v” (“h”), the +distribution is visualized along the vertical +(horizontal).
pointpos – Sets the position of the sample points in relation to +the box(es). If 0, the sample points are places over +the center of the box(es). Positive (negative) values +correspond to positions to the right (left) for +vertical boxes and above (below) for horizontal boxes
q1 – Sets the Quartile 1 values. There should be as many +items as the number of boxes desired.
q1src – Sets the source reference on Chart Studio Cloud for q1 +.
q3 – Sets the Quartile 3 values. There should be as many +items as the number of boxes desired.
q3src – Sets the source reference on Chart Studio Cloud for q3 +.
quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 +quartiles. The “linear” method uses the 25th percentile +for Q1 and 75th percentile for Q3 as computed using +method #10 (listed on http://www.amstat.org/publication +s/jse/v14n3/langford.html). The “exclusive” method uses +the median to divide the ordered dataset into two +halves if the sample is odd, it does not include the +median in either half - Q1 is then the median of the +lower half and Q3 the median of the upper half. The +“inclusive” method also uses the median to divide the +ordered dataset into two halves but if the sample is +odd, it includes the median in both halves - Q1 is then +the median of the lower half and Q3 the median of the +upper half.
sd – Sets the standard deviation values. There should be as +many items as the number of boxes desired. This +attribute has effect only under the q1/median/q3 +signature. If sd is not provided but a sample (in y +or x) is set, we compute the standard deviation for +each box using the sample values.
sdsrc – Sets the source reference on Chart Studio Cloud for sd +.
selected – plotly.graph_objects.box.Selected instance or +dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.box.Stream instance or +dict with compatible properties
text – Sets the text elements associated with each sample +value. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.box.Unselected instance +or dict with compatible properties
upperfence – Sets the upper fence values. There should be as many +items as the number of boxes desired. This attribute +has effect only under the q1/median/q3 signature. If +upperfence is not provided but a sample (in y or +x) is set, we compute the lower as the last sample +point above 1.5 times the IQR.
upperfencesrc – Sets the source reference on Chart Studio Cloud for +upperfence .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
whiskerwidth – Sets the width of the whiskers relative to the box’ +width. For example, with 1, the whiskers are as wide as +the box(es).
width – Sets the width of the box in data coordinate If 0 +(default value) the width is automatically selected +based on the positions of other box traces in the same +subplot.
x – Sets the x sample data or coordinates. See overview for +more info.
x0 – Sets the x coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y sample data or coordinates. See overview for +more info.
y0 – Sets the y coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_candlestick(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legendgroup=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Candlestick trace

The candlestick is a style of financial chart describing open, +high, low and close for a given x coordinate (most likely +time). The boxes represent the spread between the open and +close values and the lines represent the spread between the +low and high values Sample points where the close value is +higher (lower) then the open value are called increasing +(decreasing). By default, increasing candles are drawn in green +whereas decreasing are drawn in red.

Parameters

close – Sets the close values.
closesrc – Sets the source reference on Chart Studio Cloud for +close .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
decreasing – plotly.graph_objects.candlestick.Decreasing +instance or dict with compatible properties
high – Sets the high values.
highsrc – Sets the source reference on Chart Studio Cloud for +high .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.candlestick.Hoverlabel +instance or dict with compatible properties
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
increasing – plotly.graph_objects.candlestick.Increasing +instance or dict with compatible properties
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.candlestick.Line instance +or dict with compatible properties
low – Sets the low values.
lowsrc – Sets the source reference on Chart Studio Cloud for +low .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
open – Sets the open values.
opensrc – Sets the source reference on Chart Studio Cloud for +open .
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.candlestick.Stream +instance or dict with compatible properties
text – Sets hover text elements associated with each sample +point. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to this trace’s sample points.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
whiskerwidth – Sets the width of the whiskers relative to the box’ +width. For example, with 1, the whiskers are as wide as +the box(es).
x – Sets the x coordinates. If absent, linear coordinate +will be generated.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_carpet(a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Carpet trace

The data describing carpet axis layout is set in y and +(optionally) also x. If only y is present, x the plot is +interpreted as a cheater plot and is filled in using the y +values. x and y may either be 2D arrays matching with each +dimension matching that of a and b, or they may be 1D +arrays with total length equal to that of a and b.

Parameters

a – An array containing values of the first parameter value
a0 – Alternate to a. Builds a linear space of a +coordinates. Use with da where a0 is the starting +coordinate and da the step.
aaxis – plotly.graph_objects.carpet.Aaxis instance or +dict with compatible properties
asrc – Sets the source reference on Chart Studio Cloud for a +.
b – A two dimensional array of y coordinates at each carpet +point.
b0 – Alternate to b. Builds a linear space of a +coordinates. Use with db where b0 is the starting +coordinate and db the step.
baxis – plotly.graph_objects.carpet.Baxis instance or +dict with compatible properties
bsrc – Sets the source reference on Chart Studio Cloud for b +.
carpet – An identifier for this carpet, so that scattercarpet +and contourcarpet traces can specify a carpet plot on +which they lie
cheaterslope – The shift applied to each successive row of data in +creating a cheater plot. Only used if x is been +ommitted.
color – Sets default for all colors associated with this axis +all at once: line, font, tick, and grid colors. Grid +color is lightened by blending this with the plot +background Individual pieces can override this.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
da – Sets the a coordinate step. See a0 for more info.
db – Sets the b coordinate step. See b0 for more info.
font – The default font used for axis & tick labels on this +carpet
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
stream – plotly.graph_objects.carpet.Stream instance or +dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – A two dimensional array of x coordinates at each carpet +point. If ommitted, the plot is a cheater plot and the +xaxis is hidden by default.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – A two dimensional array of y coordinates at each carpet +point.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_choropleth(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Choropleth trace

The data that describes the choropleth value-to-color mapping +is set in z. The geographic locations corresponding to each +value in z are set in locations.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choropleth.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
featureidkey – Sets the key in GeoJSON features which is used as id to +match the items included in the locations array. Only +has an effect when geojson is set. Support nested +property, for example “properties.name”.
geo – Sets a reference between this trace’s geospatial +coordinates and a geographic map. If “geo” (the default +value), the geospatial coordinates refer to +layout.geo. If “geo2”, the geospatial coordinates +refer to layout.geo2, and so on.
geojson – Sets optional GeoJSON data associated with this trace. +If not given, the features on the base map are used. It +can be set as a valid GeoJSON object or as a URL +string. Note that we only accept GeoJSONs of type +“FeatureCollection” or “Feature” with geometries of +type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.choropleth.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
locationmode – Determines the set of locations used to match entries +in locations to regions on the map. Values “ISO-3”, +“USA-states”, country names correspond to features on +the base map and value “geojson-id” corresponds to +features from a custom GeoJSON linked to the geojson +attribute.
locations – Sets the coordinates via location IDs or names. See +locationmode for more info.
locationssrc – Sets the source reference on Chart Studio Cloud for +locations .
marker – plotly.graph_objects.choropleth.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
selected – plotly.graph_objects.choropleth.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.choropleth.Stream +instance or dict with compatible properties
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.choropleth.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_choroplethmapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Choroplethmapbox trace

GeoJSON features to be filled are set in geojson The data +that describes the choropleth value-to-color mapping is set in +locations and z.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
below – Determines if the choropleth polygons will be inserted +before the layer with the specified ID. By default, +choroplethmapbox traces are placed above the water +layers. If set to ‘’, the layer will be inserted above +every existing layer.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choroplethmapbox.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
featureidkey – Sets the key in GeoJSON features which is used as id to +match the items included in the locations array. +Support nested property, for example “properties.name”.
geojson – Sets the GeoJSON data associated with this trace. It +can be set as a valid GeoJSON object or as a URL +string. Note that we only accept GeoJSONs of type +“FeatureCollection” or “Feature” with geometries of +type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.choroplethmapbox.Hoverlabe +l instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable properties Anything contained +in tag <extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
locations – Sets which features found in “geojson” to plot using +their feature id field.
locationssrc – Sets the source reference on Chart Studio Cloud for +locations .
marker – plotly.graph_objects.choroplethmapbox.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
selected – plotly.graph_objects.choroplethmapbox.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.choroplethmapbox.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a mapbox subplot. If “mapbox” (the default value), +the data refer to layout.mapbox. If “mapbox2”, the +data refer to layout.mapbox2, and so on.
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.choroplethmapbox.Unselecte +d instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_cone(anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uid=None, uirevision=None, usrc=None, v=None, visible=None, vsrc=None, w=None, wsrc=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Cone trace

Use cone traces to visualize vector fields. Specify a vector +field using 6 1D arrays, 3 position arrays x, y and z and +3 vector component arrays u, v, w. The cones are drawn +exactly at the positions given by x, y and z.

Parameters

anchor – Sets the cones’ anchor with respect to their x/y/z +positions. Note that “cm” denote the cone’s center of +mass which corresponds to 1/4 from the tail to tip.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here u/v/w norm) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmin +must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as u/v/w norm. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmax +must be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.cone.ColorBar instance or +dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.cone.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable norm Anything contained in +tag <extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.cone.Lighting instance or +dict with compatible properties
lightposition – plotly.graph_objects.cone.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
sizemode – Determines whether sizeref is set as a “scaled” (i.e +unitless) scalar (normalized by the max u/v/w norm in +the vector field) or as “absolute” value (in the same +units as the vector field).
sizeref – Adjusts the cone size scaling. The size of the cones is +determined by their u/v/w norm multiplied a factor and +sizeref. This factor (computed internally) +corresponds to the minimum “time” to travel across two +successive x/y/z positions at the average velocity of +those two successive positions. All cones in a given +trace use the same factor. With sizemode set to +“scaled”, sizeref is unitless, its default value is +0.5 With sizemode set to “absolute”, sizeref has +the same units as the u/v/w vector field, its the +default value is half the sample’s maximum vector norm.
stream – plotly.graph_objects.cone.Stream instance or +dict with compatible properties
text – Sets the text elements associated with the cones. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
u – Sets the x components of the vector field.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
usrc – Sets the source reference on Chart Studio Cloud for u +.
v – Sets the y components of the vector field.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
vsrc – Sets the source reference on Chart Studio Cloud for v +.
w – Sets the z components of the vector field.
wsrc – Sets the source reference on Chart Studio Cloud for w +.
x – Sets the x coordinates of the vector field and of the +displayed cones.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates of the vector field and of the +displayed cones.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates of the vector field and of the +displayed cones.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_contour(autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Contour trace

The data from which contour lines are computed is set in z. +Data in z must be a 2D list of numbers. Say that z has N +rows and M columns, then by default, these N rows correspond to +N y coordinates (set in y or auto-generated) and the M +columns correspond to M x coordinates (set in x or auto- +generated). By setting transpose to True, the above behavior +is flipped.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
autocontour – Determines whether or not the contour level attributes +are picked by an algorithm. If True, the number of +contour levels can be set in ncontours. If False, set +the contour level attributes in contours.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.contour.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data are filled in. It is defaulted +to true if z is a one dimensional array otherwise it +is defaulted to false.
contours – plotly.graph_objects.contour.Contours instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
fillcolor – Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line +color, marker color, or marker line color, whichever is +available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.contour.Hoverlabel +instance or dict with compatible properties
hoverongaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data have hover labels associated +with them.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.contour.Line instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
ncontours – Sets the maximum number of contour levels. The actual +number of contours will be chosen automatically to be +less than or equal to the value of ncontours. Has an +effect only if autocontour is True or if +contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.contour.Stream instance +or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xtype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
ytype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_contourcarpet(a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Contourcarpet trace

Plots contours on either the first carpet axis or the carpet +axis with a matching carpet attribute. Data z is +interpreted as matching that of the corresponding carpet axis.

Parameters

a – Sets the x coordinates.
a0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
asrc – Sets the source reference on Chart Studio Cloud for a +.
atype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
autocontour – Determines whether or not the contour level attributes +are picked by an algorithm. If True, the number of +contour levels can be set in ncontours. If False, set +the contour level attributes in contours.
b – Sets the y coordinates.
b0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
bsrc – Sets the source reference on Chart Studio Cloud for b +.
btype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
carpet – The carpet of the carpet axes on which this contour +trace lies
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.contourcarpet.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contours – plotly.graph_objects.contourcarpet.Contours +instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
da – Sets the x coordinate step. See x0 for more info.
db – Sets the y coordinate step. See y0 for more info.
fillcolor – Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line +color, marker color, or marker line color, whichever is +available.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.contourcarpet.Line +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
ncontours – Sets the maximum number of contour levels. The actual +number of contours will be chosen automatically to be +less than or equal to the value of ncontours. Has an +effect only if autocontour is True or if +contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.contourcarpet.Stream +instance or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_densitymapbox(autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legendgroup=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Densitymapbox trace

Draws a bivariate kernel density estimation with a Gaussian +kernel from lon and lat coordinates and optional z values +using a colorscale.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
below – Determines if the densitymapbox trace will be inserted +before the layer with the specified ID. By default, +densitymapbox traces are placed below the first layer +of type symbol If set to ‘’, the layer will be inserted +above every existing layer.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.densitymapbox.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.densitymapbox.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (lon,lat) +pair If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (lon,lat) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for +lat .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for +lon .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
radius – Sets the radius of influence of one lon / lat point +in pixels. Increasing the value makes the densitymapbox +trace smoother, but less detailed.
radiussrc – Sets the source reference on Chart Studio Cloud for +radius .
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.densitymapbox.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a mapbox subplot. If “mapbox” (the default value), +the data refer to layout.mapbox. If “mapbox2”, the +data refer to layout.mapbox2, and so on.
text – Sets text elements associated with each (lon,lat) pair +If a single string, the same string appears over all +the data points. If an array of string, the items are +mapped in order to the this trace’s (lon,lat) +coordinates. If trace hoverinfo contains a “text” +flag and “hovertext” is not set, these elements will be +seen in the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
z – Sets the points’ weight. For example, a value of 10 +would be equivalent to having 10 points of weight 1 in +the same spot
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_funnel(alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Funnel trace

Visualize stages in a process using length-encoded bars. This +trace can be used to show data in either a part-to-whole +representation wherein each item appears in a single stage, or +in a “drop-off” representation wherein each item appears in +each stage it traversed. See also the “funnelarea” trace type +for a different approach to visualizing funnel data.

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
cliponaxis – Determines whether the text nodes are clipped about the +subplot axes. To show the text nodes above axis lines +and tick labels, make sure to set xaxis.layer and +yaxis.layer to below traces.
connector – plotly.graph_objects.funnel.Connector instance +or dict with compatible properties
constraintext – Constrain the size of text inside or outside a bar to +be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.funnel.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables percentInitial, +percentPrevious and percentTotal. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextanchor – Determines if texts are kept at center or start/end +points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.funnel.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the position where the bar is drawn (in position +axis units). In “group” barmode, traces that set +“offset” will be excluded and drawn in “overlay” mode +instead.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the funnels. With “v” (“h”), +the value of the each bar spans along the vertical +(horizontal). By default funnels are tend to be +oriented horizontally; unless only “y” array is +presented or orientation is set to “v”. Also regarding +graphs including only ‘horizontal’ funnels, “autorange” +on the “y-axis” are set to “reversed”.
outsidetextfont – Sets the font used for text lying outside the bar.
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.funnel.Stream instance or +dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textangle – Sets the angle of the tick labels with respect to the +bar. For example, a tickangle of -90 draws the tick +labels vertically. With “auto” the texts may +automatically be rotated to fit with the maximum size +in bars.
textfont – Sets the font used for text.
textinfo – Determines which trace information appear on the graph. +In the case of having multiple funnels, percentages & +totals are computed separately (per trace).
textposition – Specifies the location of the text. “inside” +positions text inside, next to the bar end (rotated +and scaled if needed). “outside” positions text +outside, next to the bar end (scaled if needed), unless +there is another bar stacked on this one, then the text +gets pushed inside. “auto” tries to position text +inside the bar, but if the bar is too small and no bar +is stacked on this one the text is moved outside.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables +percentInitial, percentPrevious, percentTotal, +label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar width (in position axis units).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_funnelarea(aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Funnelarea trace

Visualize stages in a process using area-encoded trapezoids. +This trace can be used to show data in a part-to-whole +representation similar to a “pie” trace, wherein each item +appears in a single stage. See also the “funnel” trace type for +a different approach to visualizing funnel data.

Parameters

aspectratio – Sets the ratio between height and width
baseratio – Sets the ratio between bottom length and maximum top +length.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.funnelarea.Domain +instance or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.funnelarea.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables label, color, value, +text and percent. Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
label0 – Alternate to labels. Builds a numeric set of labels. +Use with dlabel where label0 is the starting label +and dlabel the step.
labels – Sets the sector labels. If labels entries are +duplicated, we sum associated values or simply count +occurrences if values is not provided. For other +array attributes (including color) we use the first +non-empty entry among all occurrences of the label.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.funnelarea.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
scalegroup – If there are multiple funnelareas that should be sized +according to their totals, link them by providing a +non-empty group id here shared by every trace in the +same group.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.funnelarea.Stream +instance or dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Specifies the location of the textinfo.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables label, +color, value, text and percent.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
title – plotly.graph_objects.funnelarea.Title instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values of the sectors. If omitted, we count +occurrences of each label.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_heatmap(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Heatmap trace

The data that describes the heatmap value-to-color mapping is +set in z. Data in z can either be a 2D list of values +(ragged or not) or a 1D array of values. In the case where z +is a 2D list, say that z has N rows and M columns. Then, by +default, the resulting heatmap will have N partitions along the +y axis and M partitions along the x axis. In other words, the +i-th row/ j-th column cell in z is mapped to the i-th +partition of the y axis (starting from the bottom of the plot) +and the j-th partition of the x-axis (starting from the left of +the plot). This behavior can be flipped by using transpose. +Moreover, x (y) can be provided with M or M+1 (N or N+1) +elements. If M (N), then the coordinates correspond to the +center of the heatmap cells and the cells have equal width. If +M+1 (N+1), then the coordinates correspond to the edges of the +heatmap cells. In the case where z is a 1D list, the x and y +coordinates must be provided in x and y respectively to +form data triplets.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.heatmap.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data are filled in. It is defaulted +to true if z is a one dimensional array and zsmooth +is not false; otherwise it is defaulted to false.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.heatmap.Hoverlabel +instance or dict with compatible properties
hoverongaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data have hover labels associated +with them.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.heatmap.Stream instance +or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xgap – Sets the horizontal gap (in pixels) between bricks.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xtype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ygap – Sets the vertical gap (in pixels) between bricks.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
ytype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsmooth – Picks a smoothing algorithm use to smooth z data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_heatmapgl(autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Heatmapgl trace

WebGL version of the heatmap trace type.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.heatmapgl.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.heatmapgl.Hoverlabel +instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
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.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.heatmapgl.Stream instance +or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xtype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
ytype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_histogram(alignmentgroup=None, autobinx=None, autobiny=None, bingroup=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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Histogram trace

The sample data from which statistics are computed is set in +x for vertically spanning histograms and in y for +horizontally spanning histograms. Binning options are set +xbins and ybins respectively if no aggregation data is +provided.

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
autobinx – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobinx is not needed. +However, we accept autobinx: true or false and will +update xbins accordingly before deleting autobinx +from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobiny is not needed. +However, we accept autobiny: true or false and will +update ybins accordingly before deleting autobiny +from the trace.
bingroup – Set a group of histogram traces which will have +compatible bin settings. Note that traces on the same +subplot and with the same “orientation” under barmode +“stack”, “relative” and “group” are forced into the +same bingroup, Using bingroup, traces under barmode +“overlay” and on different axes (of the same axis type) +can have compatible bin settings. Note that histogram +and histogram2d* trace can share the same bingroup
cumulative – plotly.graph_objects.histogram.Cumulative +instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
error_x – plotly.graph_objects.histogram.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.histogram.ErrorY instance +or dict with compatible properties
histfunc – Specifies the binning function used for this histogram +trace. If “count”, the histogram values are computed by +counting the number of values lying inside each bin. If +“sum”, “avg”, “min”, “max”, the histogram values are +computed using the sum, the average, the minimum or the +maximum of the values lying inside each bin +respectively.
histnorm – Specifies the type of normalization used for this +histogram trace. If “”, the span of each bar +corresponds to the number of occurrences (i.e. the +number of data points lying inside the bins). If +“percent” / “probability”, the span of each bar +corresponds to the percentage / fraction of occurrences +with respect to the total number of sample points +(here, the sum of all bin HEIGHTS equals 100% / 1). If +“density”, the span of each bar corresponds to the +number of occurrences in a bin divided by the size of +the bin interval (here, the sum of all bin AREAS equals +the total number of sample points). If probability +density, the area of each bar corresponds to the +probability that an event will fall into the +corresponding bin (here, the sum of all bin AREAS +equals 1).
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.histogram.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable binNumber Anything contained +in tag <extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.histogram.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +ybins.size is provided.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the +value of the each bar spans along the vertical +(horizontal).
selected – plotly.graph_objects.histogram.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.histogram.Stream instance +or dict with compatible properties
text – Sets hover text elements associated with each bar. If a +single string, the same string appears over all bars. +If an array of string, the items are mapped in order to +the this trace’s coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.histogram.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xbins – plotly.graph_objects.histogram.XBins instance +or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ybins – plotly.graph_objects.histogram.YBins instance +or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_histogram2d(autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Histogram2d trace

The sample data from which statistics are computed is set in +x and y (where x and y represent marginal +distributions, binning is set in xbins and ybins in this +case) or z (where z represent the 2D distribution and +binning set, binning is set by x and y in this case). The +resulting distribution is visualized as a heatmap.

Parameters

autobinx – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobinx is not needed. +However, we accept autobinx: true or false and will +update xbins accordingly before deleting autobinx +from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobiny is not needed. +However, we accept autobiny: true or false and will +update ybins accordingly before deleting autobiny +from the trace.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
bingroup – Set the xbingroup and ybingroup default prefix For +example, setting a bingroup of 1 on two histogram2d +traces will make them their x-bins and y-bins match +separately.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.histogram2d.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
histfunc – Specifies the binning function used for this histogram +trace. If “count”, the histogram values are computed by +counting the number of values lying inside each bin. If +“sum”, “avg”, “min”, “max”, the histogram values are +computed using the sum, the average, the minimum or the +maximum of the values lying inside each bin +respectively.
histnorm – Specifies the type of normalization used for this +histogram trace. If “”, the span of each bar +corresponds to the number of occurrences (i.e. the +number of data points lying inside the bins). If +“percent” / “probability”, the span of each bar +corresponds to the percentage / fraction of occurrences +with respect to the total number of sample points +(here, the sum of all bin HEIGHTS equals 100% / 1). If +“density”, the span of each bar corresponds to the +number of occurrences in a bin divided by the size of +the bin interval (here, the sum of all bin AREAS equals +the total number of sample points). If probability +density, the area of each bar corresponds to the +probability that an event will fall into the +corresponding bin (here, the sum of all bin AREAS +equals 1).
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.histogram2d.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable z Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.histogram2d.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +ybins.size is provided.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.histogram2d.Stream +instance or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xbingroup – Set a group of histogram traces which will have +compatible x-bin settings. Using xbingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible x-bin settings. +Note that the same xbingroup value can be used to set +(1D) histogram bingroup
xbins – plotly.graph_objects.histogram2d.XBins +instance or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xgap – Sets the horizontal gap (in pixels) between bricks.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ybingroup – Set a group of histogram traces which will have +compatible y-bin settings. Using ybingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible y-bin settings. +Note that the same ybingroup value can be used to set +(1D) histogram bingroup
ybins – plotly.graph_objects.histogram2d.YBins +instance or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ygap – Sets the vertical gap (in pixels) between bricks.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the aggregation data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsmooth – Picks a smoothing algorithm use to smooth z data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_histogram2dcontour(autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legendgroup=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, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Histogram2dContour trace

Parameters

autobinx – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobinx is not needed. +However, we accept autobinx: true or false and will +update xbins accordingly before deleting autobinx +from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobiny is not needed. +However, we accept autobiny: true or false and will +update ybins accordingly before deleting autobiny +from the trace.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
autocontour – Determines whether or not the contour level attributes +are picked by an algorithm. If True, the number of +contour levels can be set in ncontours. If False, set +the contour level attributes in contours.
bingroup – Set the xbingroup and ybingroup default prefix For +example, setting a bingroup of 1 on two histogram2d +traces will make them their x-bins and y-bins match +separately.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.histogram2dcontour.ColorBa +r instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contours – plotly.graph_objects.histogram2dcontour.Contour +s instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
histfunc – Specifies the binning function used for this histogram +trace. If “count”, the histogram values are computed by +counting the number of values lying inside each bin. If +“sum”, “avg”, “min”, “max”, the histogram values are +computed using the sum, the average, the minimum or the +maximum of the values lying inside each bin +respectively.
histnorm – Specifies the type of normalization used for this +histogram trace. If “”, the span of each bar +corresponds to the number of occurrences (i.e. the +number of data points lying inside the bins). If +“percent” / “probability”, the span of each bar +corresponds to the percentage / fraction of occurrences +with respect to the total number of sample points +(here, the sum of all bin HEIGHTS equals 100% / 1). If +“density”, the span of each bar corresponds to the +number of occurrences in a bin divided by the size of +the bin interval (here, the sum of all bin AREAS equals +the total number of sample points). If probability +density, the area of each bar corresponds to the +probability that an event will fall into the +corresponding bin (here, the sum of all bin AREAS +equals 1).
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.histogram2dcontour.Hoverla +bel instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable z Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.histogram2dcontour.Line +instance or dict with compatible properties
marker – plotly.graph_objects.histogram2dcontour.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +ybins.size is provided.
ncontours – Sets the maximum number of contour levels. The actual +number of contours will be chosen automatically to be +less than or equal to the value of ncontours. Has an +effect only if autocontour is True or if +contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.histogram2dcontour.Stream +instance or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xbingroup – Set a group of histogram traces which will have +compatible x-bin settings. Using xbingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible x-bin settings. +Note that the same xbingroup value can be used to set +(1D) histogram bingroup
xbins – plotly.graph_objects.histogram2dcontour.XBins +instance or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ybingroup – Set a group of histogram traces which will have +compatible y-bin settings. Using ybingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible y-bin settings. +Note that the same ybingroup value can be used to set +(1D) histogram bingroup
ybins – plotly.graph_objects.histogram2dcontour.YBins +instance or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the aggregation data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_image(colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=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, zsrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Image trace

Display an image, i.e. data on a 2D regular raster. By default, +when an image is displayed in a subplot, its y axis will be +reversed (ie. autorange: 'reversed'), constrained to the +domain (ie. constrain: 'domain') and it will have the same +scale as its x axis (ie. scaleanchor: 'x,) in order for +pixels to be rendered as squares.

Parameters

colormodel – Color model used to map the numerical color components +described in z into colors.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Set the pixel’s horizontal size.
dy – Set the pixel’s vertical size
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.image.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables z, color and colormodel. +Anything contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
stream – plotly.graph_objects.image.Stream instance or +dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x0 – Set the image’s x position.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
y0 – Set the image’s y position.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
z – A 2-dimensional array in which each element is an array +of 3 or 4 numbers representing a color.
zmax – Array defining the higher bound for each color +component. Note that the default value will depend on +the colormodel. For the rgb colormodel, it is [255, +255, 255]. For the rgba colormodel, it is [255, 255, +255, 1]. For the hsl colormodel, it is [360, 100, +100]. For the hsla colormodel, it is [360, 100, 100, +1].
zmin – Array defining the lower bound for each color +component. Note that the default value will depend on +the colormodel. For the rgb colormodel, it is [0, 0, +0]. For the rgba colormodel, it is [0, 0, 0, 0]. For +the hsl colormodel, it is [0, 0, 0]. For the hsla +colormodel, it is [0, 0, 0, 0].
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_indicator(align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Indicator trace

An indicator is used to visualize a single value along with +some contextual information such as steps or a threshold, +using a combination of three visual elements: a number, a +delta, and/or a gauge. Deltas are taken with respect to a +reference. Gauges can be either angular or bullet (aka +linear) gauges.

Parameters

align – Sets the horizontal alignment of the text within the +box. Note that this attribute has no effect if an +angular gauge is displayed: in this case, it is always +centered
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
delta – plotly.graph_objects.indicator.Delta instance +or dict with compatible properties
domain – plotly.graph_objects.indicator.Domain instance +or dict with compatible properties
gauge – The gauge of the Indicator plot.
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines how the value is displayed on the graph. +number displays the value numerically in text. +delta displays the difference to a reference value in +text. Finally, gauge displays the value graphically +on an axis.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
number – plotly.graph_objects.indicator.Number instance +or dict with compatible properties
stream – plotly.graph_objects.indicator.Stream instance +or dict with compatible properties
title – plotly.graph_objects.indicator.Title instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
value – Sets the number to be displayed.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_isosurface(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legendgroup=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, valuesrc=None, visible=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Isosurface trace

Draws isosurfaces between iso-min and iso-max values with +coordinates given by four 1-dimensional arrays containing the +value, x, y and z of every vertex of a uniform or non- +uniform 3-D grid. Horizontal or vertical slices, caps as well +as spaceframe between iso-min and iso-max values could also be +drawn using this trace.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
caps – plotly.graph_objects.isosurface.Caps instance +or dict with compatible properties
cauto – Determines whether or not the color domain is computed +with respect to the input data (here value) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as value and if set, cmin must +be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as value. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as value and if set, cmax must +be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.isosurface.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contour – plotly.graph_objects.isosurface.Contour +instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
flatshading – Determines whether or not normal smoothing is applied +to the meshes, creating meshes with an angular, low- +poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.isosurface.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.isosurface.Lighting +instance or dict with compatible properties
lightposition – plotly.graph_objects.isosurface.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
slices – plotly.graph_objects.isosurface.Slices +instance or dict with compatible properties
spaceframe – plotly.graph_objects.isosurface.Spaceframe +instance or dict with compatible properties
stream – plotly.graph_objects.isosurface.Stream +instance or dict with compatible properties
surface – plotly.graph_objects.isosurface.Surface +instance or dict with compatible properties
text – Sets the text elements associated with the vertices. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
value – Sets the 4th dimension (value) of the vertices.
valuesrc – Sets the source reference on Chart Studio Cloud for +value .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the X coordinates of the vertices on X axis.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the Y coordinates of the vertices on Y axis.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the Z coordinates of the vertices on Z axis.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_layout_image(arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, **kwargs)¶

Create and add a new image to the figure’s layout

Parameters

arg – instance of Image or dict with compatible properties
layer – Specifies whether images are drawn below or above +traces. When xref and yref are both set to paper, +image is drawn below the entire plot area.
name – When used in a template, named items are created in the +output figure in addition to any items the figure +already has in this array. You can modify these items +in the output figure by making your own item with +templateitemname matching this name alongside your +modifications (including visible: false or enabled: +false to hide it). Has no effect outside of a +template.
opacity – Sets the opacity of the image.
sizex – Sets the image container size horizontally. The image +will be sized based on the position value. When +xref is set to paper, units are sized relative to +the plot width.
sizey – Sets the image container size vertically. The image +will be sized based on the position value. When +yref is set to paper, units are sized relative to +the plot height.
sizing – Specifies which dimension of the image to constrain.
source – Specifies the URL of the image to be used. The URL must +be accessible from the domain where the plot code is +run, and can be either relative or absolute.
templateitemname – Used to refer to a named item in this array in the +template. Named items from the template will be created +even without a matching item in the input figure, but +you can modify one by making an item with +templateitemname matching its name, alongside your +modifications (including visible: false or enabled: +false to hide it). If there is no template or no +matching item, this item will be hidden unless you +explicitly show it with visible: true.
visible – Determines whether or not this image is visible.
x – Sets the image’s x position. When xref is set to +paper, units are sized relative to the plot height. +See xref for more info
xanchor – Sets the anchor for the x position
xref – Sets the images’s x coordinate axis. If set to a x axis +id (e.g. “x” or “x2”), the x position refers to an x +data coordinate If set to “paper”, the x position +refers to the distance from the left of plot in +normalized coordinates where 0 (1) corresponds to the +left (right).
y – Sets the image’s y position. When yref is set to +paper, units are sized relative to the plot height. +See yref for more info
yanchor – Sets the anchor for the y position.
yref – Sets the images’s y coordinate axis. If set to a y axis +id (e.g. “y” or “y2”), the y position refers to a y +data coordinate. If set to “paper”, the y position +refers to the distance from the bottom of the plot in +normalized coordinates where 0 (1) corresponds to the +bottom (top).
row – Subplot row for image
col – Subplot column for image
secondary_y – Whether to add image to secondary y-axis

Returns

Return type

Figure

+ +

+add_mesh3d(alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, 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, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Mesh3d trace

Draws sets of triangles with coordinates given by three +1-dimensional arrays in x, y, z and (1) a sets of i, +j, k indices (2) Delaunay triangulation or (3) the Alpha- +shape algorithm or (4) the Convex-hull algorithm

Parameters

alphahull – Determines how the mesh surface triangles are derived +from the set of vertices (points) represented by the +x, y and z arrays, if the i, j, k arrays +are not supplied. For general use of mesh3d it is +preferred that i, j, k are supplied. If “-1”, +Delaunay triangulation is used, which is mainly +suitable if the mesh is a single, more or less layer +surface that is perpendicular to delaunayaxis. In +case the delaunayaxis intersects the mesh surface at +more than one point it will result triangles that are +very long in the dimension of delaunayaxis. If “>0”, +the alpha-shape algorithm is used. In this case, the +positive alphahull value signals the use of the +alpha-shape algorithm, _and_ its value acts as the +parameter for the mesh fitting. If 0, the convex-hull +algorithm is used. It is suitable for convex bodies or +if the intention is to enclose the x, y and z +point set into a convex hull.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here intensity) or +the bounds set in cmin and cmax Defaults to +false when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as intensity and if set, cmin +must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as intensity. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as intensity and if set, cmax +must be set as well.
color – Sets the color of the whole mesh
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.mesh3d.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contour – plotly.graph_objects.mesh3d.Contour instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
delaunayaxis – Sets the Delaunay axis, which is the axis that is +perpendicular to the surface of the Delaunay +triangulation. It has an effect if i, j, k are +not provided and alphahull is set to indicate +Delaunay triangulation.
facecolor – Sets the color of each face Overrides “color” and +“vertexcolor”.
facecolorsrc – Sets the source reference on Chart Studio Cloud for +facecolor .
flatshading – Determines whether or not normal smoothing is applied +to the meshes, creating meshes with an angular, low- +poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.mesh3d.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
i – A vector of vertex indices, i.e. integer values between +0 and the length of the vertex vectors, representing +the “first” vertex of a triangle. For example, {i[m], +j[m], k[m]} together represent face m (triangle m) in +the mesh, where i[m] = n points to the triplet +{x[n], y[n], z[n]} in the vertex arrays. Therefore, +each element in i represents a point in space, which +is the first vertex of a triangle.
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
intensity – Sets the intensity values for vertices or cells as +defined by intensitymode. It can be used for plotting +fields on meshes.
intensitymode – Determines the source of intensity values.
intensitysrc – Sets the source reference on Chart Studio Cloud for +intensity .
isrc – Sets the source reference on Chart Studio Cloud for i +.
j – A vector of vertex indices, i.e. integer values between +0 and the length of the vertex vectors, representing +the “second” vertex of a triangle. For example, {i[m], +j[m], k[m]} together represent face m (triangle m) in +the mesh, where j[m] = n points to the triplet +{x[n], y[n], z[n]} in the vertex arrays. Therefore, +each element in j represents a point in space, which +is the second vertex of a triangle.
jsrc – Sets the source reference on Chart Studio Cloud for j +.
k – A vector of vertex indices, i.e. integer values between +0 and the length of the vertex vectors, representing +the “third” vertex of a triangle. For example, {i[m], +j[m], k[m]} together represent face m (triangle m) in +the mesh, where k[m] = n points to the triplet +{x[n], y[n], z[n]} in the vertex arrays. Therefore, +each element in k represents a point in space, which +is the third vertex of a triangle.
ksrc – Sets the source reference on Chart Studio Cloud for k +.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.mesh3d.Lighting instance +or dict with compatible properties
lightposition – plotly.graph_objects.mesh3d.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.mesh3d.Stream instance or +dict with compatible properties
text – Sets the text elements associated with the vertices. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
vertexcolor – Sets the color of each vertex Overrides “color”. While +Red, green and blue colors are in the range of 0 and +255; in the case of having vertex color data in RGBA +format, the alpha color should be normalized to be +between 0 and 1.
vertexcolorsrc – Sets the source reference on Chart Studio Cloud for +vertexcolor .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the X coordinates of the vertices. The nth element +of vectors x, y and z jointly represent the X, Y +and Z coordinates of the nth vertex.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the Y coordinates of the vertices. The nth element +of vectors x, y and z jointly represent the X, Y +and Z coordinates of the nth vertex.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the Z coordinates of the vertices. The nth element +of vectors x, y and z jointly represent the X, Y +and Z coordinates of the nth vertex.
zcalendar – Sets the calendar system to use with z date data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_ohlc(close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legendgroup=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Ohlc trace

The ohlc (short for Open-High-Low-Close) is a style of +financial chart describing open, high, low and close for a +given x coordinate (most likely time). The tip of the lines +represent the low and high values and the horizontal +segments represent the open and close values. Sample points +where the close value is higher (lower) then the open value are +called increasing (decreasing). By default, increasing items +are drawn in green whereas decreasing are drawn in red.

Parameters

close – Sets the close values.
closesrc – Sets the source reference on Chart Studio Cloud for +close .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
decreasing – plotly.graph_objects.ohlc.Decreasing instance +or dict with compatible properties
high – Sets the high values.
highsrc – Sets the source reference on Chart Studio Cloud for +high .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.ohlc.Hoverlabel instance +or dict with compatible properties
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
increasing – plotly.graph_objects.ohlc.Increasing instance +or dict with compatible properties
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.ohlc.Line instance or +dict with compatible properties
low – Sets the low values.
lowsrc – Sets the source reference on Chart Studio Cloud for +low .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
open – Sets the open values.
opensrc – Sets the source reference on Chart Studio Cloud for +open .
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.ohlc.Stream instance or +dict with compatible properties
text – Sets hover text elements associated with each sample +point. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to this trace’s sample points.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
tickwidth – Sets the width of the open/close tick marks relative to +the “x” minimal interval.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates. If absent, linear coordinate +will be generated.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_parcats(arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Parcats trace

Parallel categories diagram for multidimensional categorical +data.

Parameters

arrangement – Sets the drag interaction mode for categories and +dimensions. If perpendicular, the categories can only +move along a line perpendicular to the paths. If +freeform, the categories can freely move on the +plane. If fixed, the categories and dimensions are +stationary.
bundlecolors – Sort paths so that like colors are bundled together +within each category.
counts – The number of observations represented by each state. +Defaults to 1 so that each state represents one +observation
countssrc – Sets the source reference on Chart Studio Cloud for +counts .
dimensions – The dimensions (variables) of the parallel categories +diagram.
dimensiondefaults – When used in a template (as +layout.template.data.parcats.dimensiondefaults), sets +the default property values to use for elements of +parcats.dimensions
domain – plotly.graph_objects.parcats.Domain instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoveron – Sets the hover interaction mode for the parcats +diagram. If category, hover interaction take place +per category. If color, hover interactions take place +per color per category. If dimension, hover +interactions take place across all categories per +dimension.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables count, probability, +category, categorycount, colorcount and +bandcolorcount. Anything contained in tag <extra> +is displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
labelfont – Sets the font for the dimension labels.
line – plotly.graph_objects.parcats.Line instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
sortpaths – Sets the path sorting algorithm. If forward, sort +paths based on dimension categories from left to right. +If backward, sort paths based on dimensions +categories from right to left.
stream – plotly.graph_objects.parcats.Stream instance +or dict with compatible properties
tickfont – Sets the font for the category labels.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_parcoords(customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Parcoords trace

Parallel coordinates for multidimensional exploratory data +analysis. The samples are specified in dimensions. The colors +are set in line.color.

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dimensions – The dimensions (variables) of the parallel coordinates +chart. 2..60 dimensions are supported.
dimensiondefaults – When used in a template (as +layout.template.data.parcoords.dimensiondefaults), sets +the default property values to use for elements of +parcoords.dimensions
domain – plotly.graph_objects.parcoords.Domain instance +or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
labelangle – Sets the angle of the labels with respect to the +horizontal. For example, a tickangle of -90 draws the +labels vertically. Tilted labels with “labelangle” may +be positioned better inside margins when +labelposition is set to “bottom”.
labelfont – Sets the font for the dimension labels.
labelside – Specifies the location of the label. “top” positions +labels above, next to the title “bottom” positions +labels below the graph Tilted labels with “labelangle” +may be positioned better inside margins when +labelposition is set to “bottom”.
line – plotly.graph_objects.parcoords.Line instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
rangefont – Sets the font for the dimension range values.
stream – plotly.graph_objects.parcoords.Stream instance +or dict with compatible properties
tickfont – Sets the font for the dimension tick values.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_pie(automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legendgroup=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, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Pie trace

A data visualized by the sectors of the pie is set in values. +The sector labels are set in labels. The sector colors are +set in marker.colors

Parameters

automargin – Determines whether outside text labels can push the +margins.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
direction – Specifies the direction at which succeeding sectors +follow one another.
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.pie.Domain instance or +dict with compatible properties
hole – Sets the fraction of the radius to cut out of the pie. +Use this to make a donut chart.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.pie.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables label, color, value, +percent and text. Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
insidetextorientation – Controls the orientation of the text inside chart +sectors. When set to “auto”, text may be oriented in +any direction in order to be as big as possible in the +middle of a sector. The “horizontal” option orients +text to be parallel with the bottom of the chart, and +may make text smaller in order to achieve that goal. +The “radial” option orients text along the radius of +the sector. The “tangential” option orients text +perpendicular to the radius of the sector.
label0 – Alternate to labels. Builds a numeric set of labels. +Use with dlabel where label0 is the starting label +and dlabel the step.
labels – Sets the sector labels. If labels entries are +duplicated, we sum associated values or simply count +occurrences if values is not provided. For other +array attributes (including color) we use the first +non-empty entry among all occurrences of the label.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.pie.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the +sector.
pull – Sets the fraction of larger radius to pull the sectors +out from the center. This can be a constant to pull all +slices apart from each other equally or an array to +highlight one or more slices.
pullsrc – Sets the source reference on Chart Studio Cloud for +pull .
rotation – Instead of the first slice starting at 12 o’clock, +rotate to some other angle.
scalegroup – If there are multiple pie charts that should be sized +according to their totals, link them by providing a +non-empty group id here shared by every trace in the +same group.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
sort – Determines whether or not the sectors are reordered +from largest to smallest.
stream – plotly.graph_objects.pie.Stream instance or +dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Specifies the location of the textinfo.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables label, +color, value, percent and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
title – plotly.graph_objects.pie.Title instance or +dict with compatible properties
titlefont – Deprecated: Please use pie.title.font instead. Sets the +font used for title. Note that the title’s font used +to be set by the now deprecated titlefont attribute.
titleposition – Deprecated: Please use pie.title.position instead. +Specifies the location of the title. Note that the +title’s position used to be set by the now deprecated +titleposition attribute.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values of the sectors. If omitted, we count +occurrences of each label.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_pointcloud(customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Pointcloud trace

The data visualized as a point cloud set in x and y using +the WebGl plotting engine.

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.pointcloud.Hoverlabel +instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
indices – A sequential value, 0..n, supply it to avoid creating +this array inside plotting. If specified, it must be a +typed Int32Array array. Its length must be equal to +or greater than the number of points. For the best +performance and memory use, create one large indices +typed array that is guaranteed to be at least as long +as the largest number of points during use, and reuse +it on each Plotly.restyle() call.
indicessrc – Sets the source reference on Chart Studio Cloud for +indices .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.pointcloud.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.pointcloud.Stream +instance or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
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.
xbounds – Specify xbounds in the shape of [xMin, xMax] to +avoid looping through the `xy typed array. Use it in +conjunction with xy and ybounds for the performance +benefits.
xboundssrc – Sets the source reference on Chart Studio Cloud for +xbounds .
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xy – Faster alternative to specifying x and y +separately. If supplied, it must be a typed +Float32Array array that represents points such that +xy[i * 2] = x[i] and xy[i * 2 + 1] = y[i]
xysrc – Sets the source reference on Chart Studio Cloud for xy +.
y – Sets the y coordinates.
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.
ybounds – Specify ybounds in the shape of [yMin, yMax] to +avoid looping through the `xy typed array. Use it in +conjunction with xy and xbounds for the performance +benefits.
yboundssrc – Sets the source reference on Chart Studio Cloud for +ybounds .
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_sankey(arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Sankey trace

Sankey plots for network flow data analysis. The nodes are +specified in nodes and the links between sources and targets +in links. The colors are set in nodes[i].color and +links[i].color, otherwise defaults are used.

Parameters

arrangement – If value is snap (the default), the node arrangement +is assisted by automatic snapping of elements to +preserve space between nodes specified via nodepad. +If value is perpendicular, the nodes can only move +along a line perpendicular to the flow. If value is +freeform, the nodes can freely move on the plane. If +value is fixed, the nodes are stationary.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.sankey.Domain instance or +dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired. Note that this attribute is +superseded by node.hoverinfo and node.hoverinfo for +nodes and links respectively.
hoverlabel – plotly.graph_objects.sankey.Hoverlabel +instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
link – The links of the Sankey plot.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
node – The nodes of the Sankey plot.
orientation – Sets the orientation of the Sankey diagram.
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
stream – plotly.graph_objects.sankey.Stream instance or +dict with compatible properties
textfont – Sets the font for node labels
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
valueformat – Sets the value formatting rule using d3 formatting +mini-language which is similar to those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
valuesuffix – Adds a unit to follow the value in the hover tooltip. +Add a space if a separation is necessary from the +value.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_scatter(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, orientation=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, t=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Scatter trace

The scatter trace type encompasses line charts, scatter charts, +text charts, and bubble charts. The data visualized as scatter +point or lines is set in x and y. Text (appearing either on +the chart or on hover only) is via text. Bubble charts are +achieved by setting marker.size and/or marker.color to +numerical arrays.

Parameters

cliponaxis – Determines whether or not markers and text nodes are +clipped about the subplot axes. To show markers and +text nodes above axis lines and tick labels, make sure +to set xaxis.layer and yaxis.layer to below +traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.scatter.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.scatter.ErrorY instance +or dict with compatible properties
fill – Sets the area to fill with a solid color. Defaults to +“none” unless this trace is stacked, then it gets +“tonexty” (“tonextx”) if orientation is “v” (“h”) Use +with fillcolor if not “none”. “tozerox” and “tozeroy” +fill to x=0 and y=0 respectively. “tonextx” and +“tonexty” fill between the endpoints of this trace and +the endpoints of the trace before it, connecting those +endpoints with straight lines (to make a stacked area +graph); if there is no trace before it, they behave +like “tozerox” and “tozeroy”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other. Traces in a stackgroup will only fill to (or +be filled to) other traces in the same group. With +multiple `stackgroup`s or some traces stacked and some +not, if fill-linked traces are not already consecutive, +the later ones will be pushed down in the drawing +order.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
groupnorm – Only relevant when stackgroup is used, and only the +first groupnorm found in the stackgroup will be +used - including if visible is “legendonly” but not +if it is false. Sets the normalization for the sum of +this stackgroup. With “fraction”, the value of each +trace at each location is divided by the sum of all +trace values at that location. “percent” is the same +but multiplied by 100 to show percentages. If there are +multiple subplots, or multiple `stackgroup`s on one +subplot, each will be normalized within its own set.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatter.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatter.Line instance or +dict with compatible properties
marker – plotly.graph_objects.scatter.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
orientation – Only relevant 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.
r – r coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the radial +coordinatesfor legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.scatter.Selected instance +or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stackgaps – Only relevant when stackgroup is used, and only the +first stackgaps found in the stackgroup will be +used - including if visible is “legendonly” but not +if it is false. Determines how we handle locations at +which other traces in this group have data but this one +does not. With infer zero we insert a zero at these +locations. With “interpolate” we linearly interpolate +between existing values, and extrapolate a constant +beyond the existing values.
stackgroup – Set several scatter traces (on the same subplot) to the +same stackgroup in order to add their y values (or +their x values if orientation is “h”). If blank or +omitted this trace will not be stacked. Stacking also +turns fill on by default, using “tonexty” (“tonextx”) +if orientation is “h” (“v”) and sets the default +mode to “lines” irrespective of point count. You can +only stack on a numeric (linear or log) axis. Traces in +a stackgroup will only fill to (or be filled to) +other traces in the same group. With multiple +`stackgroup`s or some traces stacked and some not, if +fill-linked traces are not already consecutive, the +later ones will be pushed down in the drawing order.
stream – plotly.graph_objects.scatter.Stream instance +or dict with compatible properties
t – t coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the +angular coordinatesfor legacy polar chart only.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
tsrc – Sets the source reference on Chart Studio Cloud for t +.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatter.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_scatter3d(connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Scatter3d trace

The data visualized as scatter point or lines in 3D dimension +is set in x, y, z. Text (appearing either on the chart or +on hover only) is via text. Bubble charts are achieved by +setting marker.size and/or marker.color Projections are +achieved via projection. Surface fills are achieved via +surfaceaxis.

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
error_x – plotly.graph_objects.scatter3d.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.scatter3d.ErrorY instance +or dict with compatible properties
error_z – plotly.graph_objects.scatter3d.ErrorZ instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatter3d.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets text elements associated with each (x,y,z) +triplet. If a single string, the same string appears +over all the data points. If an array of string, the +items are mapped in order to the this trace’s (x,y,z) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatter3d.Line instance +or dict with compatible properties
marker – plotly.graph_objects.scatter3d.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
projection – plotly.graph_objects.scatter3d.Projection +instance or dict with compatible properties
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatter3d.Stream instance +or dict with compatible properties
surfaceaxis – If “-1”, the scatter points are not fill with a surface +If 0, 1, 2, the scatter points are filled with a +Delaunay surface about the x, y, z respectively.
surfacecolor – Sets the surface fill color.
text – Sets text elements associated with each (x,y,z) +triplet. If a single string, the same string appears +over all the data points. If an array of string, the +items are mapped in order to the this trace’s (x,y,z) +coordinates. If trace hoverinfo contains a “text” +flag and “hovertext” is not set, these elements will be +seen in the hover labels.
textfont – plotly.graph_objects.scatter3d.Textfont +instance or dict with compatible properties
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with z date data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_scattercarpet(a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Scattercarpet trace

Plots a scatter trace on either the first carpet axis or the +carpet axis with a matching carpet attribute.

Parameters

a – Sets the a-axis coordinates.
asrc – Sets the source reference on Chart Studio Cloud for a +.
b – Sets the b-axis coordinates.
bsrc – Sets the source reference on Chart Studio Cloud for b +.
carpet – An identifier for this carpet, so that scattercarpet +and contourcarpet traces can specify a carpet plot on +which they lie
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. scatterternary has a subset +of the options available to scatter. “toself” connects +the endpoints of the trace (or each segment of the +trace if it has gaps) into a closed shape. “tonext” +fills the space between two traces if one completely +encloses the other (eg consecutive contour lines), and +behaves like “toself” if there is no trace before it. +“tonext” should not be used if one trace does not +enclose the other.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattercarpet.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (a,b) +point. If a single string, the same string appears over +all the data points. If an array of strings, the items +are mapped in order to the the data points in (a,b). To +be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattercarpet.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scattercarpet.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattercarpet.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattercarpet.Stream +instance or dict with compatible properties
text – Sets text elements associated with each (a,b) point. If +a single string, the same string appears over all the +data points. If an array of strings, the items are +mapped in order to the the data points in (a,b). If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables a, b and +text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattercarpet.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_scattergeo(connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legendgroup=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Scattergeo trace

The data visualized as scatter point or lines on a geographic +map is provided either by longitude/latitude pairs in lon and +lat respectively or by geographic location IDs or names in +locations.

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
featureidkey – Sets the key in GeoJSON features which is used as id to +match the items included in the locations array. Only +has an effect when geojson is set. Support nested +property, for example “properties.name”.
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
geo – Sets a reference between this trace’s geospatial +coordinates and a geographic map. If “geo” (the default +value), the geospatial coordinates refer to +layout.geo. If “geo2”, the geospatial coordinates +refer to layout.geo2, and so on.
geojson – Sets optional GeoJSON data associated with this trace. +If not given, the features on the base map are used +when locations is set. It can be set as a valid +GeoJSON object or as a URL string. Note that we only +accept GeoJSONs of type “FeatureCollection” or +“Feature” with geometries of type “Polygon” or +“MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattergeo.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (lon,lat) +pair or item in locations. If a single string, the +same string appears over all the data points. If an +array of string, the items are mapped in order to the +this trace’s (lon,lat) or locations coordinates. To +be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for +lat .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattergeo.Line instance +or dict with compatible properties
locationmode – Determines the set of locations used to match entries +in locations to regions on the map. Values “ISO-3”, +“USA-states”, country names correspond to features on +the base map and value “geojson-id” corresponds to +features from a custom GeoJSON linked to the geojson +attribute.
locations – Sets the coordinates via location IDs or names. +Coordinates correspond to the centroid of each location +given. See locationmode for more info.
locationssrc – Sets the source reference on Chart Studio Cloud for +locations .
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for +lon .
marker – plotly.graph_objects.scattergeo.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattergeo.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattergeo.Stream +instance or dict with compatible properties
text – Sets text elements associated with each (lon,lat) pair +or item in locations. If a single string, the same +string appears over all the data points. If an array of +string, the items are mapped in order to the this +trace’s (lon,lat) or locations coordinates. If trace +hoverinfo contains a “text” flag and “hovertext” is +not set, these elements will be seen in the hover +labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables lat, lon, +location and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattergeo.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_scattergl(connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Scattergl trace

The data visualized as scatter point or lines is set in x and +y using the WebGL plotting engine. Bubble charts are achieved +by setting marker.size and/or marker.color to a numerical +arrays.

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.scattergl.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.scattergl.ErrorY instance +or dict with compatible properties
fill – Sets the area to fill with a solid color. Defaults to +“none” unless this trace is stacked, then it gets +“tonexty” (“tonextx”) if orientation is “v” (“h”) Use +with fillcolor if not “none”. “tozerox” and “tozeroy” +fill to x=0 and y=0 respectively. “tonextx” and +“tonexty” fill between the endpoints of this trace and +the endpoints of the trace before it, connecting those +endpoints with straight lines (to make a stacked area +graph); if there is no trace before it, they behave +like “tozerox” and “tozeroy”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other. Traces in a stackgroup will only fill to (or +be filled to) other traces in the same group. With +multiple `stackgroup`s or some traces stacked and some +not, if fill-linked traces are not already consecutive, +the later ones will be pushed down in the drawing +order.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattergl.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattergl.Line instance +or dict with compatible properties
marker – plotly.graph_objects.scattergl.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattergl.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattergl.Stream instance +or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattergl.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_scattermapbox(below=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, legendgroup=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Scattermapbox trace

The data visualized as scatter point, lines or marker symbols +on a Mapbox GL geographic map is provided by longitude/latitude +pairs in lon and lat.

Parameters

below – Determines if this scattermapbox trace’s layers are to +be inserted before the layer with the specified ID. By +default, scattermapbox layers are inserted above all +the base layers. To place the scattermapbox layers +above every other layer, set below to “’‘”.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattermapbox.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (lon,lat) +pair If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (lon,lat) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for +lat .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattermapbox.Line +instance or dict with compatible properties
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for +lon .
marker – plotly.graph_objects.scattermapbox.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattermapbox.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattermapbox.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a mapbox subplot. If “mapbox” (the default value), +the data refer to layout.mapbox. If “mapbox2”, the +data refer to layout.mapbox2, and so on.
text – Sets text elements associated with each (lon,lat) pair +If a single string, the same string appears over all +the data points. If an array of string, the items are +mapped in order to the this trace’s (lon,lat) +coordinates. If trace hoverinfo contains a “text” +flag and “hovertext” is not set, these elements will be +seen in the hover labels.
textfont – Sets the icon text font (color=mapbox.layer.paint.text- +color, size=mapbox.layer.layout.text-size). Has an +effect only when type is set to “symbol”.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables lat, lon +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattermapbox.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_scatterpolar(cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Scatterpolar trace

The scatterpolar trace type encompasses line charts, scatter +charts, text charts, and bubble charts in polar coordinates. +The data visualized as scatter point or lines is set in r +(radial) and theta (angular) coordinates Text (appearing +either on the chart or on hover only) is via text. Bubble +charts are achieved by setting marker.size and/or +marker.color to numerical arrays.

Parameters

cliponaxis – Determines whether or not markers and text nodes are +clipped about the subplot axes. To show markers and +text nodes above axis lines and tick labels, make sure +to set xaxis.layer and yaxis.layer to below +traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the +dtheta step equals the subplot’s period divided by +the length of the r coordinates.
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. scatterpolar has a subset of +the options available to scatter. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatterpolar.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatterpolar.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scatterpolar.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r +coordinates. Use with dr where r0 is the starting +coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.scatterpolar.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatterpolar.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a polar subplot. If “polar” (the default value), +the data refer to layout.polar. If “polar2”, the data +refer to layout.polar2, and so on.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables r, theta +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the +starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for +theta .
thetaunit – Sets the unit of input “theta” values. Has an effect +only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterpolar.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_scatterpolargl(connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Scatterpolargl trace

The scatterpolargl trace type encompasses line charts, scatter +charts, and bubble charts in polar coordinates using the WebGL +plotting engine. The data visualized as scatter point or lines +is set in r (radial) and theta (angular) coordinates Bubble +charts are achieved by setting marker.size and/or +marker.color to numerical arrays.

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the +dtheta step equals the subplot’s period divided by +the length of the r coordinates.
fill – Sets the area to fill with a solid color. Defaults to +“none” unless this trace is stacked, then it gets +“tonexty” (“tonextx”) if orientation is “v” (“h”) Use +with fillcolor if not “none”. “tozerox” and “tozeroy” +fill to x=0 and y=0 respectively. “tonextx” and +“tonexty” fill between the endpoints of this trace and +the endpoints of the trace before it, connecting those +endpoints with straight lines (to make a stacked area +graph); if there is no trace before it, they behave +like “tozerox” and “tozeroy”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other. Traces in a stackgroup will only fill to (or +be filled to) other traces in the same group. With +multiple `stackgroup`s or some traces stacked and some +not, if fill-linked traces are not already consecutive, +the later ones will be pushed down in the drawing +order.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatterpolargl.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatterpolargl.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scatterpolargl.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r +coordinates. Use with dr where r0 is the starting +coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.scatterpolargl.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatterpolargl.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a polar subplot. If “polar” (the default value), +the data refer to layout.polar. If “polar2”, the data +refer to layout.polar2, and so on.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables r, theta +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the +starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for +theta .
thetaunit – Sets the unit of input “theta” values. Has an effect +only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterpolargl.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_scatterternary(a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Scatterternary trace

Provides similar functionality to the “scatter” type but on a +ternary phase diagram. The data is provided by at least two +arrays out of a, b, c triplets.

Parameters

a – Sets the quantity of component a in each data point. +If a, b, and c are all provided, they need not be +normalized, only the relative values matter. If only +two arrays are provided they must be normalized to +match ternary.sum.
asrc – Sets the source reference on Chart Studio Cloud for a +.
b – Sets the quantity of component a in each data point. +If a, b, and c are all provided, they need not be +normalized, only the relative values matter. If only +two arrays are provided they must be normalized to +match ternary.sum.
bsrc – Sets the source reference on Chart Studio Cloud for b +.
c – Sets the quantity of component a in each data point. +If a, b, and c are all provided, they need not be +normalized, only the relative values matter. If only +two arrays are provided they must be normalized to +match ternary.sum.
cliponaxis – Determines whether or not markers and text nodes are +clipped about the subplot axes. To show markers and +text nodes above axis lines and tick labels, make sure +to set xaxis.layer and yaxis.layer to below +traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
csrc – Sets the source reference on Chart Studio Cloud for c +.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. scatterternary has a subset +of the options available to scatter. “toself” connects +the endpoints of the trace (or each segment of the +trace if it has gaps) into a closed shape. “tonext” +fills the space between two traces if one completely +encloses the other (eg consecutive contour lines), and +behaves like “toself” if there is no trace before it. +“tonext” should not be used if one trace does not +enclose the other.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatterternary.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (a,b,c) +point. If a single string, the same string appears over +all the data points. If an array of strings, the items +are mapped in order to the the data points in (a,b,c). +To be seen, trace hoverinfo must contain a “text” +flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatterternary.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scatterternary.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scatterternary.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatterternary.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a ternary subplot. If “ternary” (the default +value), the data refer to layout.ternary. If +“ternary2”, the data refer to layout.ternary2, and so +on.
sum – The number each triplet should sum to, if only two of +a, b, and c are provided. This overrides +ternary.sum to normalize this specific trace, but +does not affect the values displayed on the axes. 0 (or +missing) means to use ternary.sum
text – Sets text elements associated with each (a,b,c) point. +If a single string, the same string appears over all +the data points. If an array of strings, the items are +mapped in order to the the data points in (a,b,c). If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables a, b, c +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterternary.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_shape(arg=None, fillcolor=None, layer=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, visible=None, x0=None, x1=None, xanchor=None, xref=None, xsizemode=None, y0=None, y1=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, **kwargs)¶

Create and add a new shape to the figure’s layout

Parameters

arg – instance of Shape or dict with compatible properties
fillcolor – Sets the color filling the shape’s interior.
layer – Specifies whether shapes are drawn below or above +traces.
line – plotly.graph_objects.layout.shape.Line +instance or dict with compatible properties
name – When used in a template, named items are created in the +output figure in addition to any items the figure +already has in this array. You can modify these items +in the output figure by making your own item with +templateitemname matching this name alongside your +modifications (including visible: false or enabled: +false to hide it). Has no effect outside of a +template.
opacity – Sets the opacity of the shape.
path – For type “path” - a valid SVG path with the pixel +values replaced by data values in +xsizemode/ysizemode being “scaled” and taken +unmodified as pixels relative to xanchor and +yanchor in case of “pixel” size mode. There are a few +restrictions / quirks only absolute instructions, not +relative. So the allowed segments are: M, L, H, V, Q, +C, T, S, and Z arcs (A) are not allowed because radius +rx and ry are relative. In the future we could consider +supporting relative commands, but we would have to +decide on how to handle date and log axes. Note that +even as is, Q and C Bezier paths that are smooth on +linear axes may not be smooth on log, and vice versa. +no chained “polybezier” commands - specify the segment +type for each one. On category axes, values are numbers +scaled to the serial numbers of categories because +using the categories themselves there would be no way +to describe fractional positions On data axes: because +space and T are both normal components of path strings, +we can’t use either to separate date from time parts. +Therefore we’ll use underscore for this purpose: +2015-02-21_13:45:56.789
templateitemname – Used to refer to a named item in this array in the +template. Named items from the template will be created +even without a matching item in the input figure, but +you can modify one by making an item with +templateitemname matching its name, alongside your +modifications (including visible: false or enabled: +false to hide it). If there is no template or no +matching item, this item will be hidden unless you +explicitly show it with visible: true.
type – Specifies the shape type to be drawn. If “line”, a line +is drawn from (x0,`y0`) to (x1,`y1`) with respect +to the axes’ sizing mode. If “circle”, a circle is +drawn from ((x0`+`x1)/2, (y0`+`y1)/2)) with radius +(|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with +respect to the axes’ sizing mode. If “rect”, a +rectangle is drawn linking (x0,`y0`), (x1,`y0`), +(x1,`y1`), (x0,`y1`), (x0,`y0`) with respect to +the axes’ sizing mode. If “path”, draw a custom SVG +path using path. with respect to the axes’ sizing +mode.
visible – Determines whether or not this shape is visible.
x0 – Sets the shape’s starting x position. See type and +xsizemode for more info.
x1 – Sets the shape’s end x position. See type and +xsizemode for more info.
xanchor – Only relevant in conjunction with xsizemode set to +“pixel”. Specifies the anchor point on the x axis to +which x0, x1 and x coordinates within path are +relative to. E.g. useful to attach a pixel sized shape +to a certain data value. No effect when xsizemode not +set to “pixel”.
xref – Sets the shape’s x coordinate axis. If set to an x axis +id (e.g. “x” or “x2”), the x position refers to an x +coordinate. If set to “paper”, the x position refers +to the distance from the left side of the plotting area +in normalized coordinates where 0 (1) corresponds to +the left (right) side. If the axis type is “log”, +then you must take the log of your desired range. If +the axis type is “date”, then you must convert the +date to unix time in milliseconds.
xsizemode – Sets the shapes’s sizing mode along the x axis. If set +to “scaled”, x0, x1 and x coordinates within path +refer to data values on the x axis or a fraction of the +plot area’s width (xref set to “paper”). If set to +“pixel”, xanchor specifies the x position in terms of +data or plot fraction but x0, x1 and x coordinates +within path are pixels relative to xanchor. This +way, the shape can have a fixed width while maintaining +a position relative to data or plot fraction.
y0 – Sets the shape’s starting y position. See type and +ysizemode for more info.
y1 – Sets the shape’s end y position. See type and +ysizemode for more info.
yanchor – Only relevant in conjunction with ysizemode set to +“pixel”. Specifies the anchor point on the y axis to +which y0, y1 and y coordinates within path are +relative to. E.g. useful to attach a pixel sized shape +to a certain data value. No effect when ysizemode not +set to “pixel”.
yref – Sets the annotation’s y coordinate axis. If set to an y +axis id (e.g. “y” or “y2”), the y position refers to +an y coordinate If set to “paper”, the y position +refers to the distance from the bottom of the plotting +area in normalized coordinates where 0 (1) corresponds +to the bottom (top).
ysizemode – Sets the shapes’s sizing mode along the y axis. If set +to “scaled”, y0, y1 and y coordinates within path +refer to data values on the y axis or a fraction of the +plot area’s height (yref set to “paper”). If set to +“pixel”, yanchor specifies the y position in terms of +data or plot fraction but y0, y1 and y coordinates +within path are pixels relative to yanchor. This +way, the shape can have a fixed height while +maintaining a position relative to data or plot +fraction.
row – Subplot row for shape
col – Subplot column for shape
secondary_y – Whether to add shape to secondary y-axis

Returns

Return type

Figure

+ +

+add_splom(customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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, yaxes=None, row=None, col=None, **kwargs)¶

Add a new Splom trace

Splom traces generate scatter plot matrix visualizations. Each +splom dimensions items correspond to a generated axis. Values +for each of those dimensions are set in dimensions[i].values. +Splom traces support all scattergl marker style attributes. +Specify layout.grid attributes and/or layout x-axis and +y-axis attributes for more control over the axis positioning +and style.

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
diagonal – plotly.graph_objects.splom.Diagonal instance +or dict with compatible properties
dimensions – A tuple of +plotly.graph_objects.splom.Dimension instances +or dicts with compatible properties
dimensiondefaults – When used in a template (as +layout.template.data.splom.dimensiondefaults), sets the +default property values to use for elements of +splom.dimensions
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.splom.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.splom.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.splom.Selected instance +or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showlowerhalf – Determines whether or not subplots on the lower half +from the diagonal are displayed.
showupperhalf – Determines whether or not subplots on the upper half +from the diagonal are displayed.
stream – plotly.graph_objects.splom.Stream instance or +dict with compatible properties
text – Sets text elements associated with each (x,y) pair to +appear on hover. If a single string, the same string +appears over all the data points. If an array of +string, the items are mapped in order to the this +trace’s (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.splom.Unselected instance +or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
xaxes – Sets the list of x axes corresponding to dimensions of +this splom trace. By default, a splom will match the +first N xaxes where N is the number of input +dimensions. Note that, in case where diagonal.visible +is false and showupperhalf or showlowerhalf is +false, this splom trace will generate one less x-axis +and one less y-axis.
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.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_streamtube(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legendgroup=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, uid=None, uirevision=None, usrc=None, v=None, visible=None, vsrc=None, w=None, wsrc=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Streamtube trace

Use a streamtube trace to visualize flow in a vector field. +Specify a vector field using 6 1D arrays of equal length, 3 +position arrays x, y and z and 3 vector component arrays +u, v, and w. By default, the tubes’ starting positions +will be cut from the vector field’s x-z plane at its minimum y +value. To specify your own starting position, use attributes +starts.x, starts.y and starts.z. The color is encoded by +the norm of (u, v, w), and the local radius by the divergence +of (u, v, w).

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here u/v/w norm) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmin +must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as u/v/w norm. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmax +must be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.streamtube.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.streamtube.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables tubex, tubey, tubez, +tubeu, tubev, tubew, norm and divergence. +Anything contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.streamtube.Lighting +instance or dict with compatible properties
lightposition – plotly.graph_objects.streamtube.Lightposition +instance or dict with compatible properties
maxdisplayed – The maximum number of displayed segments in a +streamtube.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
sizeref – The scaling factor for the streamtubes. The default is +1, which avoids two max divergence tubes from touching +at adjacent starting positions.
starts – plotly.graph_objects.streamtube.Starts +instance or dict with compatible properties
stream – plotly.graph_objects.streamtube.Stream +instance or dict with compatible properties
text – Sets a text element associated with this trace. If +trace hoverinfo contains a “text” flag, this text +element will be seen in all hover labels. Note that +streamtube traces do not support array text values.
u – Sets the x components of the vector field.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
usrc – Sets the source reference on Chart Studio Cloud for u +.
v – Sets the y components of the vector field.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
vsrc – Sets the source reference on Chart Studio Cloud for v +.
w – Sets the z components of the vector field.
wsrc – Sets the source reference on Chart Studio Cloud for w +.
x – Sets the x coordinates of the vector field.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates of the vector field.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates of the vector field.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_sunburst(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Sunburst trace

Visualize hierarchal data spanning outward radially from root +to leaves. The sunburst sectors are determined by the entries +in “labels” or “ids” and in “parents”.

Parameters

branchvalues – Determines how the items in values are summed. When +set to “total”, items in values are taken to be value +of all its descendants. When set to “remainder”, items +in values corresponding to the root and the branches +sectors are taken to be the extra part not part of the +sum of the values at their leaves.
count – Determines default for values when it is not +provided, by inferring a 1 for each of the “leaves” +and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.sunburst.Domain instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.sunburst.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables currentPath, root, +entry, percentRoot, percentEntry and +percentParent. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
insidetextorientation – Controls the orientation of the text inside chart +sectors. When set to “auto”, text may be oriented in +any direction in order to be as big as possible in the +middle of a sector. The “horizontal” option orients +text to be parallel with the bottom of the chart, and +may make text smaller in order to achieve that goal. +The “radial” option orients text along the radius of +the sector. The “tangential” option orients text +perpendicular to the radius of the sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
leaf – plotly.graph_objects.sunburst.Leaf instance or +dict with compatible properties
level – Sets the level from which this trace hierarchy is +rendered. Set level to '' to start from the root +node in the hierarchy. Must be an “id” if ids is +filled in, otherwise plotly attempts to find a matching +item in labels.
marker – plotly.graph_objects.sunburst.Marker instance +or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given +level. Set maxdepth to “-1” to render all the +levels in the hierarchy.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the +sector. This option refers to the root of the hierarchy +presented at the center of a sunburst graph. Please +note that if a hierarchy has multiple root nodes, this +option won’t have any effect and insidetextfont would +be used.
parents – Sets the parent sectors for each of the sectors. Empty +string items ‘’ are understood to reference the root +node in the hierarchy. If ids is filled, parents +items are understood to be “ids” themselves. When ids +is not set, plotly attempts to find matching items in +labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for +parents .
stream – plotly.graph_objects.sunburst.Stream instance +or dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables +currentPath, root, entry, percentRoot, +percentEntry, percentParent, label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values associated with each of the sectors. +Use with branchvalues to determine how the values are +summed.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_surface(autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Surface trace

The data the describes the coordinates of the surface is set in +z. Data in z should be a 2D list. Coordinates in x and +y can either be 1D lists or 2D lists (e.g. to graph +parametric surfaces). If not provided in x and y, the x and +y coordinates are assumed to be linear starting at 0 with a +unit step. The color scale corresponds to the z values by +default. For custom color scales, use surfacecolor which +should be a 2D list, where its bounds can be controlled using +cmin and cmax.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here z or surfacecolor) +or the bounds set in cmin and cmax Defaults to +false when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as z or surfacecolor and if set, +cmin must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as z or surfacecolor. +Has no effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as z or surfacecolor and if set, +cmax must be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.surface.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data are filled in.
contours – plotly.graph_objects.surface.Contours instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hidesurface – Determines whether or not a surface is drawn. For +example, set hidesurface to False contours.x.show +to True and contours.y.show to True to draw a wire +frame plot.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.surface.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.surface.Lighting instance +or dict with compatible properties
lightposition – plotly.graph_objects.surface.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an +array containing arrays mapping a normalized value to +an opacity value. At minimum, a mapping for the lowest +(0) and highest (1) values are required. For example, +[[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower +values would have higher opacity values and those in +the middle would be more transparent Alternatively, +opacityscale may be a palette name string of the +following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. +The default is ‘uniform’.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.surface.Stream instance +or dict with compatible properties
surfacecolor – Sets the surface color values, used for setting a color +scale independent of z.
surfacecolorsrc – Sets the source reference on Chart Studio Cloud for +surfacecolor .
text – Sets the text elements associated with each z value. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with z date data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_table(cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Table trace

Table view for detailed data viewing. The data are arranged in +a grid of rows and columns. Most styling can be specified for +columns, rows or individual cells. Table is using a column- +major order, ie. the grid is represented as a vector of column +vectors.

Parameters

cells – plotly.graph_objects.table.Cells instance or +dict with compatible properties
columnorder – Specifies the rendered order of the data columns; for +example, a value 2 at position 0 means that column +index 0 in the data will be rendered as the third +column, as columns have an index base of zero.
columnordersrc – Sets the source reference on Chart Studio Cloud for +columnorder .
columnwidth – The width of columns expressed as a ratio. Columns fill +the available width in proportion of their specified +column widths.
columnwidthsrc – Sets the source reference on Chart Studio Cloud for +columnwidth .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.table.Domain instance or +dict with compatible properties
header – plotly.graph_objects.table.Header instance or +dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.table.Hoverlabel instance +or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
stream – plotly.graph_objects.table.Stream instance or +dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_treemap(branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs)¶

Add a new Treemap trace

Visualize hierarchal data from leaves (and/or outer branches) +towards root with rectangles. The treemap sectors are +determined by the entries in “labels” or “ids” and in +“parents”.

Parameters

branchvalues – Determines how the items in values are summed. When +set to “total”, items in values are taken to be value +of all its descendants. When set to “remainder”, items +in values corresponding to the root and the branches +sectors are taken to be the extra part not part of the +sum of the values at their leaves.
count – Determines default for values when it is not +provided, by inferring a 1 for each of the “leaves” +and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.treemap.Domain instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.treemap.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables currentPath, root, +entry, percentRoot, percentEntry and +percentParent. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
level – Sets the level from which this trace hierarchy is +rendered. Set level to '' to start from the root +node in the hierarchy. Must be an “id” if ids is +filled in, otherwise plotly attempts to find a matching +item in labels.
marker – plotly.graph_objects.treemap.Marker instance +or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given +level. Set maxdepth to “-1” to render all the +levels in the hierarchy.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the +sector. This option refers to the root of the hierarchy +presented on top left corner of a treemap graph. Please +note that if a hierarchy has multiple root nodes, this +option won’t have any effect and insidetextfont would +be used.
parents – Sets the parent sectors for each of the sectors. Empty +string items ‘’ are understood to reference the root +node in the hierarchy. If ids is filled, parents +items are understood to be “ids” themselves. When ids +is not set, plotly attempts to find matching items in +labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for +parents .
pathbar – plotly.graph_objects.treemap.Pathbar instance +or dict with compatible properties
stream – plotly.graph_objects.treemap.Stream instance +or dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Sets the positions of the text elements.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables +currentPath, root, entry, percentRoot, +percentEntry, percentParent, label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
tiling – plotly.graph_objects.treemap.Tiling instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values associated with each of the sectors. +Use with branchvalues to determine how the values are +summed.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_violin(alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legendgroup=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Violin trace

In vertical (horizontal) violin plots, statistics are computed +using y (x) values. By supplying an x (y) array, one +violin per distinct x (y) value is drawn If no x (y) list +is provided, a single violin is drawn. That violin position is +then positioned with with name or with x0 (y0) if +provided.

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
bandwidth – Sets the bandwidth used to compute the kernel density +estimate. By default, the bandwidth is determined by +Silverman’s rule of thumb.
box – plotly.graph_objects.violin.Box instance or +dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.violin.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual violins or +sample points or the kernel density estimate or any +combination of them?
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
jitter – Sets the amount of jitter in the sample points drawn. +If 0, the sample points align along the distribution +axis. If 1, the sample points are drawn in a random +jitter of width equal to the width of the violins.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.violin.Line instance or +dict with compatible properties
marker – plotly.graph_objects.violin.Marker instance or +dict with compatible properties
meanline – plotly.graph_objects.violin.Meanline instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover. For violin traces, the name +will also be used for the position coordinate, if x +and x0 (y and y0 if horizontal) are missing and +the position axis is categorical. Note that the trace +name is also used as a default value for attribute +scalegroup (please see its description for details).
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the violin(s). If “v” (“h”), +the distribution is visualized along the vertical +(horizontal).
pointpos – Sets the position of the sample points in relation to +the violins. If 0, the sample points are places over +the center of the violins. Positive (negative) values +correspond to positions to the right (left) for +vertical violins and above (below) for horizontal +violins.
points – If “outliers”, only the sample points lying outside the +whiskers are shown If “suspectedoutliers”, the outlier +points are shown and points either less than 4*Q1-3*Q3 +or greater than 4*Q3-3*Q1 are highlighted (see +outliercolor) If “all”, all sample points are shown +If False, only the violins are shown with no sample +points. Defaults to “suspectedoutliers” when +marker.outliercolor or marker.line.outliercolor is +set, otherwise defaults to “outliers”.
scalegroup – If there are multiple violins that should be sized +according to to some metric (see scalemode), link +them by providing a non-empty group id here shared by +every trace in the same group. If a violin’s width is +undefined, scalegroup will default to the trace’s +name. In this case, violins with the same names will be +linked together
scalemode – Sets the metric by which the width of each violin is +determined.”width” means each violin has the same (max) +width*count* means the violins are scaled by the number +of sample points makingup each violin.
selected – plotly.graph_objects.violin.Selected instance +or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
side – Determines on which side of the position value the +density function making up one half of a violin is +plotted. Useful when comparing two violin traces under +“overlay” mode, where one trace has side set to +“positive” and the other to “negative”.
span – Sets the span in data space for which the density +function will be computed. Has an effect only when +spanmode is set to “manual”.
spanmode – Sets the method by which the span in data space where +the density function will be computed. “soft” means the +span goes from the sample’s minimum value minus two +bandwidths to the sample’s maximum value plus two +bandwidths. “hard” means the span goes from the +sample’s minimum to its maximum value. For custom span +settings, use mode “manual” and fill in the span +attribute.
stream – plotly.graph_objects.violin.Stream instance or +dict with compatible properties
text – Sets the text elements associated with each sample +value. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.violin.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the width of the violin in data coordinates. If 0 +(default value) the width is automatically selected +based on the positions of other violin traces in the +same subplot.
x – Sets the x sample data or coordinates. See overview for +more info.
x0 – Sets the x coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y sample data or coordinates. See overview for +more info.
y0 – Sets the y coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+add_volume(autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legendgroup=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, valuesrc=None, visible=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, row=None, col=None, **kwargs)¶

Add a new Volume trace

Draws volume trace between iso-min and iso-max values with +coordinates given by four 1-dimensional arrays containing the +value, x, y and z of every vertex of a uniform or non- +uniform 3-D grid. Horizontal or vertical slices, caps as well +as spaceframe between iso-min and iso-max values could also be +drawn using this trace.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
caps – plotly.graph_objects.volume.Caps instance or +dict with compatible properties
cauto – Determines whether or not the color domain is computed +with respect to the input data (here value) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as value and if set, cmin must +be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as value. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as value and if set, cmax must +be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.volume.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contour – plotly.graph_objects.volume.Contour instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
flatshading – Determines whether or not normal smoothing is applied +to the meshes, creating meshes with an angular, low- +poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.volume.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.volume.Lighting instance +or dict with compatible properties
lightposition – plotly.graph_objects.volume.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an +array containing arrays mapping a normalized value to +an opacity value. At minimum, a mapping for the lowest +(0) and highest (1) values are required. For example, +[[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower +values would have higher opacity values and those in +the middle would be more transparent Alternatively, +opacityscale may be a palette name string of the +following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. +The default is ‘uniform’.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
slices – plotly.graph_objects.volume.Slices instance or +dict with compatible properties
spaceframe – plotly.graph_objects.volume.Spaceframe +instance or dict with compatible properties
stream – plotly.graph_objects.volume.Stream instance or +dict with compatible properties
surface – plotly.graph_objects.volume.Surface instance +or dict with compatible properties
text – Sets the text elements associated with the vertices. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
value – Sets the 4th dimension (value) of the vertices.
valuesrc – Sets the source reference on Chart Studio Cloud for +value .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the X coordinates of the vertices on X axis.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the Y coordinates of the vertices on Y axis.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the Z coordinates of the vertices on Z axis.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

Figure

+ +

+add_waterfall(alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs)¶

Add a new Waterfall trace

Draws waterfall trace which is useful graph to displays the +contribution of various elements (either positive or negative) +in a bar chart. The data visualized by the span of the bars is +set in y if orientation is set th “v” (the default) and the +labels are set in x. By setting orientation to “h”, the +roles are interchanged.

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
base – Sets where the bar base is drawn (in position axis +units).
cliponaxis – Determines whether the text nodes are clipped about the +subplot axes. To show the text nodes above axis lines +and tick labels, make sure to set xaxis.layer and +yaxis.layer to below traces.
connector – plotly.graph_objects.waterfall.Connector +instance or dict with compatible properties
constraintext – Constrain the size of text inside or outside a bar to +be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
decreasing – plotly.graph_objects.waterfall.Decreasing +instance or dict with compatible properties
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.waterfall.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables initial, delta and +final. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
increasing – plotly.graph_objects.waterfall.Increasing +instance or dict with compatible properties
insidetextanchor – Determines if texts are kept at center or start/end +points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
measure – An array containing types of values. By default the +values are considered as ‘relative’. However; it is +possible to use ‘total’ to compute the sums. Also +‘absolute’ could be applied to reset the computed total +or to declare an initial value where needed.
measuresrc – Sets the source reference on Chart Studio Cloud for +measure .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the position where the bar is drawn (in position +axis units). In “group” barmode, traces that set +“offset” will be excluded and drawn in “overlay” mode +instead.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
offsetsrc – Sets the source reference on Chart Studio Cloud for +offset .
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the +value of the each bar spans along the vertical +(horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.waterfall.Stream instance +or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textangle – Sets the angle of the tick labels with respect to the +bar. For example, a tickangle of -90 draws the tick +labels vertically. With “auto” the texts may +automatically be rotated to fit with the maximum size +in bars.
textfont – Sets the font used for text.
textinfo – Determines which trace information appear on the graph. +In the case of having multiple waterfalls, totals are +computed separately (per trace).
textposition – Specifies the location of the text. “inside” +positions text inside, next to the bar end (rotated +and scaled if needed). “outside” positions text +outside, next to the bar end (scaled if needed), unless +there is another bar stacked on this one, then the text +gets pushed inside. “auto” tries to position text +inside the bar, but if the bar is too small and no bar +is stacked on this one the text is moved outside.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables initial, +delta, final and label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
totals – plotly.graph_objects.waterfall.Totals instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar width (in position axis units).
widthsrc – Sets the source reference on Chart Studio Cloud for +width .
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

Figure

+ +

+for_each_annotation(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all annotations that satisfy the specified selection +criteria

Parameters

fn – Function that inputs a single annotation object.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all annotations are +selected.
col (row,) – Subplot row and column index of annotations to select. +To select annotations by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +annotations that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
- If True, only select annotations associated with the secondary +y-axis of the subplot.
- If False, only select annotations associated with the primary +y-axis of the subplot.
- If None (the default), do not filter annotations based on secondary +y-axis.
+
To select annotations by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_coloraxis(fn, selector=None, row=None, col=None)¶

Apply a function to all coloraxis objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single coloraxis object.
selector (dict or None (default None)) – Dict to use as selection criteria. +coloraxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all coloraxis objects are selected.
col (row,) – Subplot row and column index of coloraxis objects to select. +To select coloraxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all coloraxis objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_geo(fn, selector=None, row=None, col=None)¶

Apply a function to all geo objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single geo object.
selector (dict or None (default None)) – Dict to use as selection criteria. +geo objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all geo objects are selected.
col (row,) – Subplot row and column index of geo objects to select. +To select geo objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all geo objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_layout_image(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all images that satisfy the specified selection +criteria

Parameters

fn – Function that inputs a single image object.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all images are +selected.
col (row,) – Subplot row and column index of images to select. +To select images by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +images that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
- If True, only select images associated with the secondary +y-axis of the subplot.
- If False, only select images associated with the primary +y-axis of the subplot.
- If None (the default), do not filter images based on secondary +y-axis.
+
To select images by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_mapbox(fn, selector=None, row=None, col=None)¶

Apply a function to all mapbox objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single mapbox object.
selector (dict or None (default None)) – Dict to use as selection criteria. +mapbox objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all mapbox objects are selected.
col (row,) – Subplot row and column index of mapbox objects to select. +To select mapbox objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all mapbox objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_polar(fn, selector=None, row=None, col=None)¶

Apply a function to all polar objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single polar object.
selector (dict or None (default None)) – Dict to use as selection criteria. +polar objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all polar objects are selected.
col (row,) – Subplot row and column index of polar objects to select. +To select polar objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all polar objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_scene(fn, selector=None, row=None, col=None)¶

Apply a function to all scene objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single scene object.
selector (dict or None (default None)) – Dict to use as selection criteria. +scene objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all scene objects are selected.
col (row,) – Subplot row and column index of scene objects to select. +To select scene objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all scene objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_shape(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all shapes that satisfy the specified selection +criteria

Parameters

fn – Function that inputs a single shape object.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all shapes are +selected.
col (row,) – Subplot row and column index of shapes to select. +To select shapes by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +shapes that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
- If True, only select shapes associated with the secondary +y-axis of the subplot.
- If False, only select shapes associated with the primary +y-axis of the subplot.
- If None (the default), do not filter shapes based on secondary +y-axis.
+
To select shapes by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_ternary(fn, selector=None, row=None, col=None)¶

Apply a function to all ternary objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single ternary object.
selector (dict or None (default None)) – Dict to use as selection criteria. +ternary objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all ternary objects are selected.
col (row,) – Subplot row and column index of ternary objects to select. +To select ternary objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all ternary objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_xaxis(fn, selector=None, row=None, col=None)¶

Apply a function to all xaxis objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single xaxis object.
selector (dict or None (default None)) – Dict to use as selection criteria. +xaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all xaxis objects are selected.
col (row,) – Subplot row and column index of xaxis objects to select. +To select xaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all xaxis objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_yaxis(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all yaxis objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single yaxis object.
selector (dict or None (default None)) – Dict to use as selection criteria. +yaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all yaxis objects are selected.
col (row,) – Subplot row and column index of yaxis objects to select. +To select yaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
- If True, only select yaxis objects associated with the secondary +y-axis of the subplot.
- If False, only select yaxis objects associated with the primary +y-axis of the subplot.
- If None (the default), do not filter yaxis objects based on +a secondary y-axis condition.
+
To select yaxis objects by secondary y-axis, the Figure must +have been created using plotly.subplots.make_subplots. See +the docstring for the specs argument to make_subplots for more +info on creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+select_annotations(selector=None, row=None, col=None, secondary_y=None)¶

Select annotations from a particular subplot cell and/or annotations +that satisfy custom selection criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +Annotations will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all annotations are +selected.
col (row,) – Subplot row and column index of annotations to select. +To select annotations by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +annotation that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
- If True, only select annotations associated with the secondary +y-axis of the subplot.
- If False, only select annotations associated with the primary +y-axis of the subplot.
- If None (the default), do not filter annotations based on secondary +y-axis.
+
To select annotations by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the annotations that satisfy +all of the specified selection criteria

Return type

generator

+ +

+select_coloraxes(selector=None, row=None, col=None)¶

Select coloraxis subplot objects from a particular subplot cell +and/or coloraxis subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +coloraxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all coloraxis objects are selected.
col (row,) – Subplot row and column index of coloraxis objects to select. +To select coloraxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all coloraxis objects are selected.

Returns

Generator that iterates through all of the coloraxis +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_geos(selector=None, row=None, col=None)¶

Select geo subplot objects from a particular subplot cell +and/or geo subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +geo objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all geo objects are selected.
col (row,) – Subplot row and column index of geo objects to select. +To select geo objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all geo objects are selected.

Returns

Generator that iterates through all of the geo +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_layout_images(selector=None, row=None, col=None, secondary_y=None)¶

Select images from a particular subplot cell and/or images +that satisfy custom selection criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +Annotations will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all images are +selected.
col (row,) – Subplot row and column index of images to select. +To select images by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +image that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
- If True, only select images associated with the secondary +y-axis of the subplot.
- If False, only select images associated with the primary +y-axis of the subplot.
- If None (the default), do not filter images based on secondary +y-axis.
+
To select images by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the images that satisfy +all of the specified selection criteria

Return type

generator

+ +

+select_mapboxes(selector=None, row=None, col=None)¶

Select mapbox subplot objects from a particular subplot cell +and/or mapbox subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +mapbox objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all mapbox objects are selected.
col (row,) – Subplot row and column index of mapbox objects to select. +To select mapbox objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all mapbox objects are selected.

Returns

Generator that iterates through all of the mapbox +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_polars(selector=None, row=None, col=None)¶

Select polar subplot objects from a particular subplot cell +and/or polar subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +polar objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all polar objects are selected.
col (row,) – Subplot row and column index of polar objects to select. +To select polar objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all polar objects are selected.

Returns

Generator that iterates through all of the polar +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_scenes(selector=None, row=None, col=None)¶

Select scene subplot objects from a particular subplot cell +and/or scene subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +scene objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all scene objects are selected.
col (row,) – Subplot row and column index of scene objects to select. +To select scene objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all scene objects are selected.

Returns

Generator that iterates through all of the scene +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_shapes(selector=None, row=None, col=None, secondary_y=None)¶

Select shapes from a particular subplot cell and/or shapes +that satisfy custom selection criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +Annotations will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all shapes are +selected.
col (row,) – Subplot row and column index of shapes to select. +To select shapes by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +shape that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
- If True, only select shapes associated with the secondary +y-axis of the subplot.
- If False, only select shapes associated with the primary +y-axis of the subplot.
- If None (the default), do not filter shapes based on secondary +y-axis.
+
To select shapes by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the shapes that satisfy +all of the specified selection criteria

Return type

generator

+ +

+select_ternaries(selector=None, row=None, col=None)¶

Select ternary subplot objects from a particular subplot cell +and/or ternary subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +ternary objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all ternary objects are selected.
col (row,) – Subplot row and column index of ternary objects to select. +To select ternary objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all ternary objects are selected.

Returns

Generator that iterates through all of the ternary +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_xaxes(selector=None, row=None, col=None)¶

Select xaxis subplot objects from a particular subplot cell +and/or xaxis subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +xaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all xaxis objects are selected.
col (row,) – Subplot row and column index of xaxis objects to select. +To select xaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all xaxis objects are selected.

Returns

Generator that iterates through all of the xaxis +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_yaxes(selector=None, row=None, col=None, secondary_y=None)¶

Select yaxis subplot objects from a particular subplot cell +and/or yaxis subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +yaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all yaxis objects are selected.
col (row,) – Subplot row and column index of yaxis objects to select. +To select yaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
- If True, only select yaxis objects associated with the secondary +y-axis of the subplot.
- If False, only select yaxis objects associated with the primary +y-axis of the subplot.
- If None (the default), do not filter yaxis objects based on +a secondary y-axis condition.
+
To select yaxis objects by secondary y-axis, the Figure must +have been created using plotly.subplots.make_subplots. See +the docstring for the specs argument to make_subplots for more +info on creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the yaxis +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+update_annotations(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all annotations that satisfy the +specified selection criteria

Parameters

patch (dict or None (default None)) – Dictionary of property updates to be applied to all annotations that +satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all annotations are +selected.
col (row,) – Subplot row and column index of annotations to select. +To select annotations by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +annotation that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
- If True, only select annotations associated with the secondary +y-axis of the subplot.
- If False, only select annotations associated with the primary +y-axis of the subplot.
- If None (the default), do not filter annotations based on secondary +y-axis.
+
To select annotations by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected annotation. If +a property is specified in both patch and in **kwargs then the +one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_coloraxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all coloraxis objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +coloraxis objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +coloraxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all coloraxis objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of coloraxis objects to select. +To select coloraxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all coloraxis objects are selected.
**kwargs – Additional property updates to apply to each selected +coloraxis object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_geos(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all geo objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +geo objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +geo objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all geo objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of geo objects to select. +To select geo objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all geo objects are selected.
**kwargs – Additional property updates to apply to each selected +geo object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_layout_images(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all images that satisfy the +specified selection criteria

Parameters

patch (dict or None (default None)) – Dictionary of property updates to be applied to all images that +satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all images are +selected.
col (row,) – Subplot row and column index of images to select. +To select images by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +image that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
- If True, only select images associated with the secondary +y-axis of the subplot.
- If False, only select images associated with the primary +y-axis of the subplot.
- If None (the default), do not filter images based on secondary +y-axis.
+
To select images by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected image. If +a property is specified in both patch and in **kwargs then the +one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_mapboxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all mapbox objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +mapbox objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +mapbox objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all mapbox objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of mapbox objects to select. +To select mapbox objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all mapbox objects are selected.
**kwargs – Additional property updates to apply to each selected +mapbox object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_polars(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all polar objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +polar objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +polar objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all polar objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of polar objects to select. +To select polar objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all polar objects are selected.
**kwargs – Additional property updates to apply to each selected +polar object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_scenes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all scene objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +scene objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +scene objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all scene objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of scene objects to select. +To select scene objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all scene objects are selected.
**kwargs – Additional property updates to apply to each selected +scene object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_shapes(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all shapes that satisfy the +specified selection criteria

Parameters

patch (dict or None (default None)) – Dictionary of property updates to be applied to all shapes that +satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all shapes are +selected.
col (row,) – Subplot row and column index of shapes to select. +To select shapes by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +shape that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
- If True, only select shapes associated with the secondary +y-axis of the subplot.
- If False, only select shapes associated with the primary +y-axis of the subplot.
- If None (the default), do not filter shapes based on secondary +y-axis.
+
To select shapes by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected shape. If +a property is specified in both patch and in **kwargs then the +one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_ternaries(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all ternary objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +ternary objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +ternary objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all ternary objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of ternary objects to select. +To select ternary objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all ternary objects are selected.
**kwargs – Additional property updates to apply to each selected +ternary object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_xaxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all xaxis objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +xaxis objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +xaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all xaxis objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of xaxis objects to select. +To select xaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all xaxis objects are selected.
**kwargs – Additional property updates to apply to each selected +xaxis object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_yaxes(patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all yaxis objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +yaxis objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +yaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all yaxis objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of yaxis objects to select. +To select yaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
- If True, only select yaxis objects associated with the secondary +y-axis of the subplot.
- If False, only select yaxis objects associated with the primary +y-axis of the subplot.
- If None (the default), do not filter yaxis objects based on +a secondary y-axis condition.
+
To select yaxis objects by secondary y-axis, the Figure must +have been created using plotly.subplots.make_subplots. See +the docstring for the specs argument to make_subplots for more +info on creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected +yaxis object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+class plotly.graph_objects.Data(*args, **kwargs)¶

Bases: list

+
plotly.graph_objects.Data is deprecated.
+

Please replace it with a list or tuple of instances of the following types

plotly.graph_objects.Scatter
plotly.graph_objects.Bar
plotly.graph_objects.Area
plotly.graph_objects.Histogram
etc.

+ +

+class plotly.graph_objects.Annotations(*args, **kwargs)¶

Bases: list

+
plotly.graph_objects.Annotations is deprecated.
+

Please replace it with a list or tuple of instances of the following types

plotly.graph_objects.layout.Annotation
plotly.graph_objects.layout.scene.Annotation

+ +

+class plotly.graph_objects.Frames(*args, **kwargs)¶

Bases: list

+
plotly.graph_objects.Frames is deprecated.
+

Please replace it with a list or tuple of instances of the following types

plotly.graph_objects.Frame

+ +

+class plotly.graph_objects.AngularAxis(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.AngularAxis is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.AngularAxis
plotly.graph_objects.layout.polar.AngularAxis

+ +

+class plotly.graph_objects.Annotation(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Annotation is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.Annotation
plotly.graph_objects.layout.scene.Annotation

+ +

+class plotly.graph_objects.ColorBar(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.ColorBar is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.marker.ColorBar
plotly.graph_objects.surface.ColorBar
etc.

+ +

+class plotly.graph_objects.Contours(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Contours is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.contour.Contours
plotly.graph_objects.surface.Contours
etc.

+ +

+class plotly.graph_objects.ErrorX(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.ErrorX is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.ErrorX
plotly.graph_objects.histogram.ErrorX
etc.

+ +

+class plotly.graph_objects.ErrorY(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.ErrorY is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.ErrorY
plotly.graph_objects.histogram.ErrorY
etc.

+ +

+class plotly.graph_objects.ErrorZ(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.ErrorZ is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter3d.ErrorZ

+ +

+class plotly.graph_objects.Font(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Font is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.Font
plotly.graph_objects.layout.hoverlabel.Font
etc.

+ +

+class plotly.graph_objects.Legend(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Legend is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.Legend

+ +

+class plotly.graph_objects.Line(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Line is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.Line
plotly.graph_objects.layout.shape.Line
etc.

+ +

+class plotly.graph_objects.Margin(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Margin is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.Margin

+ +

+class plotly.graph_objects.Marker(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Marker is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.Marker
plotly.graph_objects.histogram.selected.Marker
etc.

+ +

+class plotly.graph_objects.RadialAxis(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.RadialAxis is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.RadialAxis
plotly.graph_objects.layout.polar.RadialAxis

+ +

+class plotly.graph_objects.Scene(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Scene is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.Scene

+ +

+class plotly.graph_objects.Stream(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Stream is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.scatter.Stream
plotly.graph_objects.area.Stream

+ +

+class plotly.graph_objects.XAxis(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.XAxis is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.XAxis
plotly.graph_objects.layout.scene.XAxis

+ +

+class plotly.graph_objects.YAxis(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.YAxis is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.YAxis
plotly.graph_objects.layout.scene.YAxis

+ +

+class plotly.graph_objects.ZAxis(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.ZAxis is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.layout.scene.ZAxis

+ +

+class plotly.graph_objects.XBins(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.XBins is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.histogram.XBins
plotly.graph_objects.histogram2d.XBins

+ +

+class plotly.graph_objects.YBins(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.YBins is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.histogram.YBins
plotly.graph_objects.histogram2d.YBins

+ +

+class plotly.graph_objects.Trace(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Trace is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.Scatter
plotly.graph_objects.Bar
plotly.graph_objects.Area
plotly.graph_objects.Histogram
etc.

+ +

+class plotly.graph_objects.Histogram2dcontour(*args, **kwargs)¶

Bases: dict

+
plotly.graph_objects.Histogram2dcontour is deprecated.
+

Please replace it with one of the following more specific types

plotly.graph_objects.Histogram2dContour

+ +

+class plotly.graph_objects.FigureWidget(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)¶

Bases: plotly.basewidget.BaseFigureWidget

Create and add a new annotation to the figure’s layout

Parameters

arg – instance of Annotation or dict with compatible +properties
align – Sets the horizontal alignment of the text within the +box. Has an effect only if text spans two or more +lines (i.e. text contains one or more HTML tags) +or if an explicit width is set to override the text +width.
arrowcolor – Sets the color of the annotation arrow.
arrowhead – Sets the end annotation arrow head style.
arrowside – Sets the annotation arrow head position.
arrowsize – Sets the size of the end annotation arrow head, +relative to arrowwidth. A value of 1 (default) gives +a head about 3x as wide as the line.
arrowwidth – Sets the width (in px) of annotation arrow line.
ax – Sets the x component of the arrow tail about the arrow +head. If axref is pixel, a positive (negative) +component corresponds to an arrow pointing from right +to left (left to right). If axref is an axis, this is +an absolute value on that axis, like x, NOT a +relative value.
axref – Indicates in what terms the tail of the annotation +(ax,ay) is specified. If pixel, ax is a relative +offset in pixels from x. If set to an x axis id +(e.g. “x” or “x2”), ax is specified in the same +terms as that axis. This is useful for trendline +annotations which should continue to indicate the +correct trend when zoomed.
ay – Sets the y component of the arrow tail about the arrow +head. If ayref is pixel, a positive (negative) +component corresponds to an arrow pointing from bottom +to top (top to bottom). If ayref is an axis, this is +an absolute value on that axis, like y, NOT a +relative value.
ayref – Indicates in what terms the tail of the annotation +(ax,ay) is specified. If pixel, ay is a relative +offset in pixels from y. If set to a y axis id (e.g. +“y” or “y2”), ay is specified in the same terms as +that axis. This is useful for trendline annotations +which should continue to indicate the correct trend +when zoomed.
bgcolor – Sets the background color of the annotation.
bordercolor – Sets the color of the border enclosing the annotation +text.
borderpad – Sets the padding (in px) between the text and the +enclosing border.
borderwidth – Sets the width (in px) of the border enclosing the +annotation text.
captureevents – Determines whether the annotation text box captures +mouse move and click events, or allows those events to +pass through to data points in the plot that may be +behind the annotation. By default captureevents is +False unless hovertext is provided. If you use the +event plotly_clickannotation without hovertext you +must explicitly enable captureevents.
clicktoshow – Makes this annotation respond to clicks on the plot. If +you click a data point that exactly matches the x and +y values of this annotation, and it is hidden +(visible: false), it will appear. In “onoff” mode, you +must click the same point again to make it disappear, +so if you click multiple points, you can show multiple +annotations. In “onout” mode, a click anywhere else in +the plot (on another data point or not) will hide this +annotation. If you need to show/hide this annotation in +response to different x or y values, you can set +xclick and/or yclick. This is useful for example to +label the side of a bar. To label markers though, +standoff is preferred over xclick and yclick.
font – Sets the annotation text font.
height – Sets an explicit height for the text box. null +(default) lets the text set the box height. Taller text +will be clipped.
hoverlabel – plotly.graph_objects.layout.annotation.Hoverlab +el instance or dict with compatible properties
hovertext – Sets text to appear when hovering over this annotation. +If omitted or blank, no hover label will appear.
name – When used in a template, named items are created in the +output figure in addition to any items the figure +already has in this array. You can modify these items +in the output figure by making your own item with +templateitemname matching this name alongside your +modifications (including visible: false or enabled: +false to hide it). Has no effect outside of a +template.
opacity – Sets the opacity of the annotation (text + arrow).
showarrow – Determines whether or not the annotation is drawn with +an arrow. If True, text is placed near the arrow’s +tail. If False, text lines up with the x and y +provided.
standoff – Sets a distance, in pixels, to move the end arrowhead +away from the position it is pointing at, for example +to point at the edge of a marker independent of zoom. +Note that this shortens the arrow from the ax / ay +vector, in contrast to xshift / yshift which moves +everything by this amount.
startarrowhead – Sets the start annotation arrow head style.
startarrowsize – Sets the size of the start annotation arrow head, +relative to arrowwidth. A value of 1 (default) gives +a head about 3x as wide as the line.
startstandoff – Sets a distance, in pixels, to move the start arrowhead +away from the position it is pointing at, for example +to point at the edge of a marker independent of zoom. +Note that this shortens the arrow from the ax / ay +vector, in contrast to xshift / yshift which moves +everything by this amount.
templateitemname – Used to refer to a named item in this array in the +template. Named items from the template will be created +even without a matching item in the input figure, but +you can modify one by making an item with +templateitemname matching its name, alongside your +modifications (including visible: false or enabled: +false to hide it). If there is no template or no +matching item, this item will be hidden unless you +explicitly show it with visible: true.
text – Sets the text associated with this annotation. Plotly +uses a subset of HTML tags to do things like newline +( ), bold (), italics (), hyperlinks +(<a href=’…’></a>). Tags , , +are also supported.
textangle – Sets the angle at which the text is drawn with +respect to the horizontal.
valign – Sets the vertical alignment of the text within the +box. Has an effect only if an explicit height is set to +override the text height.
visible – Determines whether or not this annotation is visible.
width – Sets an explicit width for the text box. null (default) +lets the text set the box width. Wider text will be +clipped. There is no automatic wrapping; use to +start a new line.
x – Sets the annotation’s x position. If the axis type is +“log”, then you must take the log of your desired +range. If the axis type is “date”, it should be date +strings, like date data, though Date objects and unix +milliseconds will be accepted and converted to strings. +If the axis type is “category”, it should be numbers, +using the scale where each category is assigned a +serial number from zero in the order it appears.
xanchor – Sets the text box’s horizontal position anchor This +anchor binds the x position to the “left”, “center” +or “right” of the annotation. For example, if x is +set to 1, xref to “paper” and xanchor to “right” +then the right-most portion of the annotation lines up +with the right-most edge of the plotting area. If +“auto”, the anchor is equivalent to “center” for data- +referenced annotations or if there is an arrow, whereas +for paper-referenced with no arrow, the anchor picked +corresponds to the closest side.
xclick – Toggle this annotation when clicking a data point whose +x value is xclick rather than the annotation’s x +value.
xref – Sets the annotation’s x coordinate axis. If set to an x +axis id (e.g. “x” or “x2”), the x position refers to +an x coordinate If set to “paper”, the x position +refers to the distance from the left side of the +plotting area in normalized coordinates where 0 (1) +corresponds to the left (right) side.
xshift – Shifts the position of the whole annotation and arrow +to the right (positive) or left (negative) by this many +pixels.
y – Sets the annotation’s y position. If the axis type is +“log”, then you must take the log of your desired +range. If the axis type is “date”, it should be date +strings, like date data, though Date objects and unix +milliseconds will be accepted and converted to strings. +If the axis type is “category”, it should be numbers, +using the scale where each category is assigned a +serial number from zero in the order it appears.
yanchor – Sets the text box’s vertical position anchor This +anchor binds the y position to the “top”, “middle” or +“bottom” of the annotation. For example, if y is set +to 1, yref to “paper” and yanchor to “top” then the +top-most portion of the annotation lines up with the +top-most edge of the plotting area. If “auto”, the +anchor is equivalent to “middle” for data-referenced +annotations or if there is an arrow, whereas for paper- +referenced with no arrow, the anchor picked corresponds +to the closest side.
yclick – Toggle this annotation when clicking a data point whose +y value is yclick rather than the annotation’s y +value.
yref – Sets the annotation’s y coordinate axis. If set to an y +axis id (e.g. “y” or “y2”), the y position refers to +an y coordinate If set to “paper”, the y position +refers to the distance from the bottom of the plotting +area in normalized coordinates where 0 (1) corresponds +to the bottom (top).
yshift – Shifts the position of the whole annotation and arrow +up (positive) or down (negative) by this many pixels.
row – Subplot row for annotation
col – Subplot column for annotation
secondary_y – Whether to add annotation to secondary y-axis

Returns

Return type

FigureWidget

+ +

Add a new Area trace

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.area.Hoverlabel instance +or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.area.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
r – Area traces are deprecated! Please switch to the +“barpolar” trace type. Sets the radial coordinates for +legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.area.Stream instance or +dict with compatible properties
t – Area traces are deprecated! Please switch to the +“barpolar” trace type. Sets the angular coordinates for +legacy polar chart only.
tsrc – Sets the source reference on Chart Studio Cloud for t +.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Bar trace

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
base – Sets where the bar base is drawn (in position axis +units). In “stack” or “relative” barmode, traces that +set “base” will be excluded and drawn in “overlay” mode +instead.
basesrc – Sets the source reference on Chart Studio Cloud for +base .
cliponaxis – Determines whether the text nodes are clipped about the +subplot axes. To show the text nodes above axis lines +and tick labels, make sure to set xaxis.layer and +yaxis.layer to below traces.
constraintext – Constrain the size of text inside or outside a bar to +be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.bar.ErrorX instance or +dict with compatible properties
error_y – plotly.graph_objects.bar.ErrorY instance or +dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.bar.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables value and label. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextanchor – Determines if texts are kept at center or start/end +points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.bar.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the position where the bar is drawn (in position +axis units). In “group” barmode, traces that set +“offset” will be excluded and drawn in “overlay” mode +instead.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
offsetsrc – Sets the source reference on Chart Studio Cloud for +offset .
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the +value of the each bar spans along the vertical +(horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
r – r coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the radial +coordinatesfor legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.bar.Selected instance or +dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.bar.Stream instance or +dict with compatible properties
t – t coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the +angular coordinatesfor legacy polar chart only.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textangle – Sets the angle of the tick labels with respect to the +bar. For example, a tickangle of -90 draws the tick +labels vertically. With “auto” the texts may +automatically be rotated to fit with the maximum size +in bars.
textfont – Sets the font used for text.
textposition – Specifies the location of the text. “inside” +positions text inside, next to the bar end (rotated +and scaled if needed). “outside” positions text +outside, next to the bar end (scaled if needed), unless +there is another bar stacked on this one, then the text +gets pushed inside. “auto” tries to position text +inside the bar, but if the bar is too small and no bar +is stacked on this one the text is moved outside.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables value and +label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
tsrc – Sets the source reference on Chart Studio Cloud for t +.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.bar.Unselected instance +or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar width (in position axis units).
widthsrc – Sets the source reference on Chart Studio Cloud for +width .
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Barpolar trace

The data visualized by the radial span of the bars is set in +r

Parameters

base – Sets where the bar base is drawn (in radial axis +units). In “stack” barmode, traces that set “base” will +be excluded and drawn in “overlay” mode instead.
basesrc – Sets the source reference on Chart Studio Cloud for +base .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the +dtheta step equals the subplot’s period divided by +the length of the r coordinates.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.barpolar.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.barpolar.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the angular position where the bar is drawn (in +“thetatunit” units).
offsetsrc – Sets the source reference on Chart Studio Cloud for +offset .
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r +coordinates. Use with dr where r0 is the starting +coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.barpolar.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.barpolar.Stream instance +or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a polar subplot. If “polar” (the default value), +the data refer to layout.polar. If “polar2”, the data +refer to layout.polar2, and so on.
text – Sets hover text elements associated with each bar. If a +single string, the same string appears over all bars. +If an array of string, the items are mapped in order to +the this trace’s coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the +starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for +theta .
thetaunit – Sets the unit of input “theta” values. Has an effect +only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.barpolar.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar angular width (in “thetaunit” units).
widthsrc – Sets the source reference on Chart Studio Cloud for +width .
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Box trace

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
boxmean – If True, the mean of the box(es)’ underlying +distribution is drawn as a dashed line inside the +box(es). If “sd” the standard deviation is also drawn. +Defaults to True when mean is set. Defaults to “sd” +when sd is set Otherwise defaults to False.
boxpoints – If “outliers”, only the sample points lying outside the +whiskers are shown If “suspectedoutliers”, the outlier +points are shown and points either less than 4*Q1-3*Q3 +or greater than 4*Q3-3*Q1 are highlighted (see +outliercolor) If “all”, all sample points are shown +If False, only the box(es) are shown with no sample +points Defaults to “suspectedoutliers” when +marker.outliercolor or marker.line.outliercolor is +set. Defaults to “all” under the q1/median/q3 +signature. Otherwise defaults to “outliers”.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step for multi-box traces set +using q1/median/q3.
dy – Sets the y coordinate step for multi-box traces set +using q1/median/q3.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.box.Hoverlabel instance +or dict with compatible properties
hoveron – Do the hover effects highlight individual boxes or +sample points or both?
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
jitter – Sets the amount of jitter in the sample points drawn. +If 0, the sample points align along the distribution +axis. If 1, the sample points are drawn in a random +jitter of width equal to the width of the box(es).
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.box.Line instance or dict +with compatible properties
lowerfence – Sets the lower fence values. There should be as many +items as the number of boxes desired. This attribute +has effect only under the q1/median/q3 signature. If +lowerfence is not provided but a sample (in y or +x) is set, we compute the lower as the last sample +point below 1.5 times the IQR.
lowerfencesrc – Sets the source reference on Chart Studio Cloud for +lowerfence .
marker – plotly.graph_objects.box.Marker instance or +dict with compatible properties
mean – Sets the mean values. There should be as many items as +the number of boxes desired. This attribute has effect +only under the q1/median/q3 signature. If mean is not +provided but a sample (in y or x) is set, we +compute the mean for each box using the sample values.
meansrc – Sets the source reference on Chart Studio Cloud for +mean .
median – Sets the median values. There should be as many items +as the number of boxes desired.
mediansrc – Sets the source reference on Chart Studio Cloud for +median .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover. For box traces, the name will +also be used for the position coordinate, if x and +x0 (y and y0 if horizontal) are missing and the +position axis is categorical
notched – Determines whether or not notches are drawn. Notches +displays a confidence interval around the median. We +compute the confidence interval as median +/- 1.57 * +IQR / sqrt(N), where IQR is the interquartile range and +N is the sample size. If two boxes’ notches do not +overlap there is 95% confidence their medians differ. +See https://sites.google.com/site/davidsstatistics/home +/notched-box-plots for more info. Defaults to False +unless notchwidth or notchspan is set.
notchspan – Sets the notch span from the boxes’ median values. +There should be as many items as the number of boxes +desired. This attribute has effect only under the +q1/median/q3 signature. If notchspan is not provided +but a sample (in y or x) is set, we compute it as +1.57 * IQR / sqrt(N), where N is the sample size.
notchspansrc – Sets the source reference on Chart Studio Cloud for +notchspan .
notchwidth – Sets the width of the notches relative to the box’ +width. For example, with 0, the notches are as wide as +the box(es).
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the box(es). If “v” (“h”), the +distribution is visualized along the vertical +(horizontal).
pointpos – Sets the position of the sample points in relation to +the box(es). If 0, the sample points are places over +the center of the box(es). Positive (negative) values +correspond to positions to the right (left) for +vertical boxes and above (below) for horizontal boxes
q1 – Sets the Quartile 1 values. There should be as many +items as the number of boxes desired.
q1src – Sets the source reference on Chart Studio Cloud for q1 +.
q3 – Sets the Quartile 3 values. There should be as many +items as the number of boxes desired.
q3src – Sets the source reference on Chart Studio Cloud for q3 +.
quartilemethod – Sets the method used to compute the sample’s Q1 and Q3 +quartiles. The “linear” method uses the 25th percentile +for Q1 and 75th percentile for Q3 as computed using +method #10 (listed on http://www.amstat.org/publication +s/jse/v14n3/langford.html). The “exclusive” method uses +the median to divide the ordered dataset into two +halves if the sample is odd, it does not include the +median in either half - Q1 is then the median of the +lower half and Q3 the median of the upper half. The +“inclusive” method also uses the median to divide the +ordered dataset into two halves but if the sample is +odd, it includes the median in both halves - Q1 is then +the median of the lower half and Q3 the median of the +upper half.
sd – Sets the standard deviation values. There should be as +many items as the number of boxes desired. This +attribute has effect only under the q1/median/q3 +signature. If sd is not provided but a sample (in y +or x) is set, we compute the standard deviation for +each box using the sample values.
sdsrc – Sets the source reference on Chart Studio Cloud for sd +.
selected – plotly.graph_objects.box.Selected instance or +dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.box.Stream instance or +dict with compatible properties
text – Sets the text elements associated with each sample +value. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.box.Unselected instance +or dict with compatible properties
upperfence – Sets the upper fence values. There should be as many +items as the number of boxes desired. This attribute +has effect only under the q1/median/q3 signature. If +upperfence is not provided but a sample (in y or +x) is set, we compute the lower as the last sample +point above 1.5 times the IQR.
upperfencesrc – Sets the source reference on Chart Studio Cloud for +upperfence .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
whiskerwidth – Sets the width of the whiskers relative to the box’ +width. For example, with 1, the whiskers are as wide as +the box(es).
width – Sets the width of the box in data coordinate If 0 +(default value) the width is automatically selected +based on the positions of other box traces in the same +subplot.
x – Sets the x sample data or coordinates. See overview for +more info.
x0 – Sets the x coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y sample data or coordinates. See overview for +more info.
y0 – Sets the y coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Candlestick trace

Parameters

close – Sets the close values.
closesrc – Sets the source reference on Chart Studio Cloud for +close .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
decreasing – plotly.graph_objects.candlestick.Decreasing +instance or dict with compatible properties
high – Sets the high values.
highsrc – Sets the source reference on Chart Studio Cloud for +high .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.candlestick.Hoverlabel +instance or dict with compatible properties
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
increasing – plotly.graph_objects.candlestick.Increasing +instance or dict with compatible properties
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.candlestick.Line instance +or dict with compatible properties
low – Sets the low values.
lowsrc – Sets the source reference on Chart Studio Cloud for +low .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
open – Sets the open values.
opensrc – Sets the source reference on Chart Studio Cloud for +open .
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.candlestick.Stream +instance or dict with compatible properties
text – Sets hover text elements associated with each sample +point. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to this trace’s sample points.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
whiskerwidth – Sets the width of the whiskers relative to the box’ +width. For example, with 1, the whiskers are as wide as +the box(es).
x – Sets the x coordinates. If absent, linear coordinate +will be generated.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Carpet trace

Parameters

a – An array containing values of the first parameter value
a0 – Alternate to a. Builds a linear space of a +coordinates. Use with da where a0 is the starting +coordinate and da the step.
aaxis – plotly.graph_objects.carpet.Aaxis instance or +dict with compatible properties
asrc – Sets the source reference on Chart Studio Cloud for a +.
b – A two dimensional array of y coordinates at each carpet +point.
b0 – Alternate to b. Builds a linear space of a +coordinates. Use with db where b0 is the starting +coordinate and db the step.
baxis – plotly.graph_objects.carpet.Baxis instance or +dict with compatible properties
bsrc – Sets the source reference on Chart Studio Cloud for b +.
carpet – An identifier for this carpet, so that scattercarpet +and contourcarpet traces can specify a carpet plot on +which they lie
cheaterslope – The shift applied to each successive row of data in +creating a cheater plot. Only used if x is been +ommitted.
color – Sets default for all colors associated with this axis +all at once: line, font, tick, and grid colors. Grid +color is lightened by blending this with the plot +background Individual pieces can override this.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
da – Sets the a coordinate step. See a0 for more info.
db – Sets the b coordinate step. See b0 for more info.
font – The default font used for axis & tick labels on this +carpet
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
stream – plotly.graph_objects.carpet.Stream instance or +dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – A two dimensional array of x coordinates at each carpet +point. If ommitted, the plot is a cheater plot and the +xaxis is hidden by default.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – A two dimensional array of y coordinates at each carpet +point.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Choropleth trace

The data that describes the choropleth value-to-color mapping +is set in z. The geographic locations corresponding to each +value in z are set in locations.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choropleth.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
featureidkey – Sets the key in GeoJSON features which is used as id to +match the items included in the locations array. Only +has an effect when geojson is set. Support nested +property, for example “properties.name”.
geo – Sets a reference between this trace’s geospatial +coordinates and a geographic map. If “geo” (the default +value), the geospatial coordinates refer to +layout.geo. If “geo2”, the geospatial coordinates +refer to layout.geo2, and so on.
geojson – Sets optional GeoJSON data associated with this trace. +If not given, the features on the base map are used. It +can be set as a valid GeoJSON object or as a URL +string. Note that we only accept GeoJSONs of type +“FeatureCollection” or “Feature” with geometries of +type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.choropleth.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
locationmode – Determines the set of locations used to match entries +in locations to regions on the map. Values “ISO-3”, +“USA-states”, country names correspond to features on +the base map and value “geojson-id” corresponds to +features from a custom GeoJSON linked to the geojson +attribute.
locations – Sets the coordinates via location IDs or names. See +locationmode for more info.
locationssrc – Sets the source reference on Chart Studio Cloud for +locations .
marker – plotly.graph_objects.choropleth.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
selected – plotly.graph_objects.choropleth.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.choropleth.Stream +instance or dict with compatible properties
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.choropleth.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Choroplethmapbox trace

GeoJSON features to be filled are set in geojson The data +that describes the choropleth value-to-color mapping is set in +locations and z.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
below – Determines if the choropleth polygons will be inserted +before the layer with the specified ID. By default, +choroplethmapbox traces are placed above the water +layers. If set to ‘’, the layer will be inserted above +every existing layer.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.choroplethmapbox.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
featureidkey – Sets the key in GeoJSON features which is used as id to +match the items included in the locations array. +Support nested property, for example “properties.name”.
geojson – Sets the GeoJSON data associated with this trace. It +can be set as a valid GeoJSON object or as a URL +string. Note that we only accept GeoJSONs of type +“FeatureCollection” or “Feature” with geometries of +type “Polygon” or “MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.choroplethmapbox.Hoverlabe +l instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable properties Anything contained +in tag <extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
locations – Sets which features found in “geojson” to plot using +their feature id field.
locationssrc – Sets the source reference on Chart Studio Cloud for +locations .
marker – plotly.graph_objects.choroplethmapbox.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
selected – plotly.graph_objects.choroplethmapbox.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.choroplethmapbox.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a mapbox subplot. If “mapbox” (the default value), +the data refer to layout.mapbox. If “mapbox2”, the +data refer to layout.mapbox2, and so on.
text – Sets the text elements associated with each location.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.choroplethmapbox.Unselecte +d instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
z – Sets the color values.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Cone trace

Parameters

anchor – Sets the cones’ anchor with respect to their x/y/z +positions. Note that “cm” denote the cone’s center of +mass which corresponds to 1/4 from the tail to tip.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here u/v/w norm) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmin +must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as u/v/w norm. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmax +must be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.cone.ColorBar instance or +dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.cone.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable norm Anything contained in +tag <extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.cone.Lighting instance or +dict with compatible properties
lightposition – plotly.graph_objects.cone.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
sizemode – Determines whether sizeref is set as a “scaled” (i.e +unitless) scalar (normalized by the max u/v/w norm in +the vector field) or as “absolute” value (in the same +units as the vector field).
sizeref – Adjusts the cone size scaling. The size of the cones is +determined by their u/v/w norm multiplied a factor and +sizeref. This factor (computed internally) +corresponds to the minimum “time” to travel across two +successive x/y/z positions at the average velocity of +those two successive positions. All cones in a given +trace use the same factor. With sizemode set to +“scaled”, sizeref is unitless, its default value is +0.5 With sizemode set to “absolute”, sizeref has +the same units as the u/v/w vector field, its the +default value is half the sample’s maximum vector norm.
stream – plotly.graph_objects.cone.Stream instance or +dict with compatible properties
text – Sets the text elements associated with the cones. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
u – Sets the x components of the vector field.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
usrc – Sets the source reference on Chart Studio Cloud for u +.
v – Sets the y components of the vector field.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
vsrc – Sets the source reference on Chart Studio Cloud for v +.
w – Sets the z components of the vector field.
wsrc – Sets the source reference on Chart Studio Cloud for w +.
x – Sets the x coordinates of the vector field and of the +displayed cones.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates of the vector field and of the +displayed cones.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates of the vector field and of the +displayed cones.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Contour trace

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
autocontour – Determines whether or not the contour level attributes +are picked by an algorithm. If True, the number of +contour levels can be set in ncontours. If False, set +the contour level attributes in contours.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.contour.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data are filled in. It is defaulted +to true if z is a one dimensional array otherwise it +is defaulted to false.
contours – plotly.graph_objects.contour.Contours instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
fillcolor – Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line +color, marker color, or marker line color, whichever is +available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.contour.Hoverlabel +instance or dict with compatible properties
hoverongaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data have hover labels associated +with them.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.contour.Line instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
ncontours – Sets the maximum number of contour levels. The actual +number of contours will be chosen automatically to be +less than or equal to the value of ncontours. Has an +effect only if autocontour is True or if +contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.contour.Stream instance +or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xtype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
ytype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Contourcarpet trace

Plots contours on either the first carpet axis or the carpet +axis with a matching carpet attribute. Data z is +interpreted as matching that of the corresponding carpet axis.

Parameters

a – Sets the x coordinates.
a0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
asrc – Sets the source reference on Chart Studio Cloud for a +.
atype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
autocontour – Determines whether or not the contour level attributes +are picked by an algorithm. If True, the number of +contour levels can be set in ncontours. If False, set +the contour level attributes in contours.
b – Sets the y coordinates.
b0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
bsrc – Sets the source reference on Chart Studio Cloud for b +.
btype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
carpet – The carpet of the carpet axes on which this contour +trace lies
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.contourcarpet.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contours – plotly.graph_objects.contourcarpet.Contours +instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
da – Sets the x coordinate step. See x0 for more info.
db – Sets the y coordinate step. See y0 for more info.
fillcolor – Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line +color, marker color, or marker line color, whichever is +available.
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.contourcarpet.Line +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
ncontours – Sets the maximum number of contour levels. The actual +number of contours will be chosen automatically to be +less than or equal to the value of ncontours. Has an +effect only if autocontour is True or if +contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.contourcarpet.Stream +instance or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Densitymapbox trace

Draws a bivariate kernel density estimation with a Gaussian +kernel from lon and lat coordinates and optional z values +using a colorscale.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
below – Determines if the densitymapbox trace will be inserted +before the layer with the specified ID. By default, +densitymapbox traces are placed below the first layer +of type symbol If set to ‘’, the layer will be inserted +above every existing layer.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.densitymapbox.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.densitymapbox.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (lon,lat) +pair If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (lon,lat) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for +lat .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for +lon .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
radius – Sets the radius of influence of one lon / lat point +in pixels. Increasing the value makes the densitymapbox +trace smoother, but less detailed.
radiussrc – Sets the source reference on Chart Studio Cloud for +radius .
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.densitymapbox.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a mapbox subplot. If “mapbox” (the default value), +the data refer to layout.mapbox. If “mapbox2”, the +data refer to layout.mapbox2, and so on.
text – Sets text elements associated with each (lon,lat) pair +If a single string, the same string appears over all +the data points. If an array of string, the items are +mapped in order to the this trace’s (lon,lat) +coordinates. If trace hoverinfo contains a “text” +flag and “hovertext” is not set, these elements will be +seen in the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
z – Sets the points’ weight. For example, a value of 10 +would be equivalent to having 10 points of weight 1 in +the same spot
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Funnel trace

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
cliponaxis – Determines whether the text nodes are clipped about the +subplot axes. To show the text nodes above axis lines +and tick labels, make sure to set xaxis.layer and +yaxis.layer to below traces.
connector – plotly.graph_objects.funnel.Connector instance +or dict with compatible properties
constraintext – Constrain the size of text inside or outside a bar to +be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.funnel.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables percentInitial, +percentPrevious and percentTotal. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextanchor – Determines if texts are kept at center or start/end +points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.funnel.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the position where the bar is drawn (in position +axis units). In “group” barmode, traces that set +“offset” will be excluded and drawn in “overlay” mode +instead.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the funnels. With “v” (“h”), +the value of the each bar spans along the vertical +(horizontal). By default funnels are tend to be +oriented horizontally; unless only “y” array is +presented or orientation is set to “v”. Also regarding +graphs including only ‘horizontal’ funnels, “autorange” +on the “y-axis” are set to “reversed”.
outsidetextfont – Sets the font used for text lying outside the bar.
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.funnel.Stream instance or +dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textangle – Sets the angle of the tick labels with respect to the +bar. For example, a tickangle of -90 draws the tick +labels vertically. With “auto” the texts may +automatically be rotated to fit with the maximum size +in bars.
textfont – Sets the font used for text.
textinfo – Determines which trace information appear on the graph. +In the case of having multiple funnels, percentages & +totals are computed separately (per trace).
textposition – Specifies the location of the text. “inside” +positions text inside, next to the bar end (rotated +and scaled if needed). “outside” positions text +outside, next to the bar end (scaled if needed), unless +there is another bar stacked on this one, then the text +gets pushed inside. “auto” tries to position text +inside the bar, but if the bar is too small and no bar +is stacked on this one the text is moved outside.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables +percentInitial, percentPrevious, percentTotal, +label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar width (in position axis units).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Funnelarea trace

Parameters

aspectratio – Sets the ratio between height and width
baseratio – Sets the ratio between bottom length and maximum top +length.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.funnelarea.Domain +instance or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.funnelarea.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables label, color, value, +text and percent. Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
label0 – Alternate to labels. Builds a numeric set of labels. +Use with dlabel where label0 is the starting label +and dlabel the step.
labels – Sets the sector labels. If labels entries are +duplicated, we sum associated values or simply count +occurrences if values is not provided. For other +array attributes (including color) we use the first +non-empty entry among all occurrences of the label.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.funnelarea.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
scalegroup – If there are multiple funnelareas that should be sized +according to their totals, link them by providing a +non-empty group id here shared by every trace in the +same group.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.funnelarea.Stream +instance or dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Specifies the location of the textinfo.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables label, +color, value, text and percent.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
title – plotly.graph_objects.funnelarea.Title instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values of the sectors. If omitted, we count +occurrences of each label.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Heatmap trace

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.heatmap.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data are filled in. It is defaulted +to true if z is a one dimensional array and zsmooth +is not false; otherwise it is defaulted to false.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.heatmap.Hoverlabel +instance or dict with compatible properties
hoverongaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data have hover labels associated +with them.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.heatmap.Stream instance +or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xgap – Sets the horizontal gap (in pixels) between bricks.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xtype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ygap – Sets the vertical gap (in pixels) between bricks.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
ytype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsmooth – Picks a smoothing algorithm use to smooth z data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Heatmapgl trace

WebGL version of the heatmap trace type.

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.heatmapgl.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.heatmapgl.Hoverlabel +instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
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.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.heatmapgl.Stream instance +or dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xtype – If “array”, the heatmap’s x coordinates are given by +“x” (the default behavior when x is provided). If +“scaled”, the heatmap’s x coordinates are given by “x0” +and “dx” (the default behavior when x is not +provided).
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
ytype – If “array”, the heatmap’s y coordinates are given by +“y” (the default behavior when y is provided) If +“scaled”, the heatmap’s y coordinates are given by “y0” +and “dy” (the default behavior when y is not +provided)
z – Sets the z data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Histogram trace

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
autobinx – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobinx is not needed. +However, we accept autobinx: true or false and will +update xbins accordingly before deleting autobinx +from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobiny is not needed. +However, we accept autobiny: true or false and will +update ybins accordingly before deleting autobiny +from the trace.
bingroup – Set a group of histogram traces which will have +compatible bin settings. Note that traces on the same +subplot and with the same “orientation” under barmode +“stack”, “relative” and “group” are forced into the +same bingroup, Using bingroup, traces under barmode +“overlay” and on different axes (of the same axis type) +can have compatible bin settings. Note that histogram +and histogram2d* trace can share the same bingroup
cumulative – plotly.graph_objects.histogram.Cumulative +instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
error_x – plotly.graph_objects.histogram.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.histogram.ErrorY instance +or dict with compatible properties
histfunc – Specifies the binning function used for this histogram +trace. If “count”, the histogram values are computed by +counting the number of values lying inside each bin. If +“sum”, “avg”, “min”, “max”, the histogram values are +computed using the sum, the average, the minimum or the +maximum of the values lying inside each bin +respectively.
histnorm – Specifies the type of normalization used for this +histogram trace. If “”, the span of each bar +corresponds to the number of occurrences (i.e. the +number of data points lying inside the bins). If +“percent” / “probability”, the span of each bar +corresponds to the percentage / fraction of occurrences +with respect to the total number of sample points +(here, the sum of all bin HEIGHTS equals 100% / 1). If +“density”, the span of each bar corresponds to the +number of occurrences in a bin divided by the size of +the bin interval (here, the sum of all bin AREAS equals +the total number of sample points). If probability +density, the area of each bar corresponds to the +probability that an event will fall into the +corresponding bin (here, the sum of all bin AREAS +equals 1).
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.histogram.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable binNumber Anything contained +in tag <extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.histogram.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +ybins.size is provided.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the +value of the each bar spans along the vertical +(horizontal).
selected – plotly.graph_objects.histogram.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.histogram.Stream instance +or dict with compatible properties
text – Sets hover text elements associated with each bar. If a +single string, the same string appears over all bars. +If an array of string, the items are mapped in order to +the this trace’s coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.histogram.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xbins – plotly.graph_objects.histogram.XBins instance +or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ybins – plotly.graph_objects.histogram.YBins instance +or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Histogram2d trace

Parameters

autobinx – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobinx is not needed. +However, we accept autobinx: true or false and will +update xbins accordingly before deleting autobinx +from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobiny is not needed. +However, we accept autobiny: true or false and will +update ybins accordingly before deleting autobiny +from the trace.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
bingroup – Set the xbingroup and ybingroup default prefix For +example, setting a bingroup of 1 on two histogram2d +traces will make them their x-bins and y-bins match +separately.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.histogram2d.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
histfunc – Specifies the binning function used for this histogram +trace. If “count”, the histogram values are computed by +counting the number of values lying inside each bin. If +“sum”, “avg”, “min”, “max”, the histogram values are +computed using the sum, the average, the minimum or the +maximum of the values lying inside each bin +respectively.
histnorm – Specifies the type of normalization used for this +histogram trace. If “”, the span of each bar +corresponds to the number of occurrences (i.e. the +number of data points lying inside the bins). If +“percent” / “probability”, the span of each bar +corresponds to the percentage / fraction of occurrences +with respect to the total number of sample points +(here, the sum of all bin HEIGHTS equals 100% / 1). If +“density”, the span of each bar corresponds to the +number of occurrences in a bin divided by the size of +the bin interval (here, the sum of all bin AREAS equals +the total number of sample points). If probability +density, the area of each bar corresponds to the +probability that an event will fall into the +corresponding bin (here, the sum of all bin AREAS +equals 1).
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.histogram2d.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable z Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.histogram2d.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +ybins.size is provided.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.histogram2d.Stream +instance or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xbingroup – Set a group of histogram traces which will have +compatible x-bin settings. Using xbingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible x-bin settings. +Note that the same xbingroup value can be used to set +(1D) histogram bingroup
xbins – plotly.graph_objects.histogram2d.XBins +instance or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xgap – Sets the horizontal gap (in pixels) between bricks.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ybingroup – Set a group of histogram traces which will have +compatible y-bin settings. Using ybingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible y-bin settings. +Note that the same ybingroup value can be used to set +(1D) histogram bingroup
ybins – plotly.graph_objects.histogram2d.YBins +instance or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ygap – Sets the vertical gap (in pixels) between bricks.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the aggregation data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsmooth – Picks a smoothing algorithm use to smooth z data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Histogram2dContour trace

Parameters

autobinx – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobinx is not needed. +However, we accept autobinx: true or false and will +update xbins accordingly before deleting autobinx +from the trace.
autobiny – Obsolete: since v1.42 each bin attribute is auto- +determined separately and autobiny is not needed. +However, we accept autobiny: true or false and will +update ybins accordingly before deleting autobiny +from the trace.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
autocontour – Determines whether or not the contour level attributes +are picked by an algorithm. If True, the number of +contour levels can be set in ncontours. If False, set +the contour level attributes in contours.
bingroup – Set the xbingroup and ybingroup default prefix For +example, setting a bingroup of 1 on two histogram2d +traces will make them their x-bins and y-bins match +separately.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.histogram2dcontour.ColorBa +r instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contours – plotly.graph_objects.histogram2dcontour.Contour +s instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
histfunc – Specifies the binning function used for this histogram +trace. If “count”, the histogram values are computed by +counting the number of values lying inside each bin. If +“sum”, “avg”, “min”, “max”, the histogram values are +computed using the sum, the average, the minimum or the +maximum of the values lying inside each bin +respectively.
histnorm – Specifies the type of normalization used for this +histogram trace. If “”, the span of each bar +corresponds to the number of occurrences (i.e. the +number of data points lying inside the bins). If +“percent” / “probability”, the span of each bar +corresponds to the percentage / fraction of occurrences +with respect to the total number of sample points +(here, the sum of all bin HEIGHTS equals 100% / 1). If +“density”, the span of each bar corresponds to the +number of occurrences in a bin divided by the size of +the bin interval (here, the sum of all bin AREAS equals +the total number of sample points). If probability +density, the area of each bar corresponds to the +probability that an event will fall into the +corresponding bin (here, the sum of all bin AREAS +equals 1).
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.histogram2dcontour.Hoverla +bel instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variable z Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.histogram2dcontour.Line +instance or dict with compatible properties
marker – plotly.graph_objects.histogram2dcontour.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
nbinsx – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +xbins.size is provided.
nbinsy – Specifies the maximum number of desired bins. This +value will be used in an algorithm that will decide the +optimal bin size such that the histogram best +visualizes the distribution of the data. Ignored if +ybins.size is provided.
ncontours – Sets the maximum number of contour levels. The actual +number of contours will be chosen automatically to be +less than or equal to the value of ncontours. Has an +effect only if autocontour is True or if +contours.size is missing.
opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true, zmin +will correspond to the last color in the array and +zmax will correspond to the first color.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.histogram2dcontour.Stream +instance or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the sample data to be binned on the x axis.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xbingroup – Set a group of histogram traces which will have +compatible x-bin settings. Using xbingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible x-bin settings. +Note that the same xbingroup value can be used to set +(1D) histogram bingroup
xbins – plotly.graph_objects.histogram2dcontour.XBins +instance or dict with compatible properties
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the sample data to be binned on the y axis.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ybingroup – Set a group of histogram traces which will have +compatible y-bin settings. Using ybingroup, +histogram2d and histogram2dcontour traces (on axes of +the same axis type) can have compatible y-bin settings. +Note that the same ybingroup value can be used to set +(1D) histogram bingroup
ybins – plotly.graph_objects.histogram2dcontour.YBins +instance or dict with compatible properties
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the aggregation data.
zauto – Determines whether or not the color domain is computed +with respect to the input data (here in z) or the +bounds set in zmin and zmax Defaults to false +when zmin and zmax are set by the user.
zhoverformat – Sets the hover text formatting rule using d3 formatting +mini-languages which are very similar to those in +Python. See: https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
zmax – Sets the upper bound of the color domain. Value should +have the same units as in z and if set, zmin must +be set as well.
zmid – Sets the mid-point of the color domain by scaling +zmin and/or zmax to be equidistant to this point. +Value should have the same units as in z. Has no +effect when zauto is false.
zmin – Sets the lower bound of the color domain. Value should +have the same units as in z and if set, zmax must +be set as well.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Image trace

Parameters

colormodel – Color model used to map the numerical color components +described in z into colors.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Set the pixel’s horizontal size.
dy – Set the pixel’s vertical size
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.image.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables z, color and colormodel. +Anything contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
stream – plotly.graph_objects.image.Stream instance or +dict with compatible properties
text – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x0 – Set the image’s x position.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
y0 – Set the image’s y position.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
z – A 2-dimensional array in which each element is an array +of 3 or 4 numbers representing a color.
zmax – Array defining the higher bound for each color +component. Note that the default value will depend on +the colormodel. For the rgb colormodel, it is [255, +255, 255]. For the rgba colormodel, it is [255, 255, +255, 1]. For the hsl colormodel, it is [360, 100, +100]. For the hsla colormodel, it is [360, 100, 100, +1].
zmin – Array defining the lower bound for each color +component. Note that the default value will depend on +the colormodel. For the rgb colormodel, it is [0, 0, +0]. For the rgba colormodel, it is [0, 0, 0, 0]. For +the hsl colormodel, it is [0, 0, 0]. For the hsla +colormodel, it is [0, 0, 0, 0].
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Indicator trace

Parameters

align – Sets the horizontal alignment of the text within the +box. Note that this attribute has no effect if an +angular gauge is displayed: in this case, it is always +centered
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
delta – plotly.graph_objects.indicator.Delta instance +or dict with compatible properties
domain – plotly.graph_objects.indicator.Domain instance +or dict with compatible properties
gauge – The gauge of the Indicator plot.
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines how the value is displayed on the graph. +number displays the value numerically in text. +delta displays the difference to a reference value in +text. Finally, gauge displays the value graphically +on an axis.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
number – plotly.graph_objects.indicator.Number instance +or dict with compatible properties
stream – plotly.graph_objects.indicator.Stream instance +or dict with compatible properties
title – plotly.graph_objects.indicator.Title instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
value – Sets the number to be displayed.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Isosurface trace

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
caps – plotly.graph_objects.isosurface.Caps instance +or dict with compatible properties
cauto – Determines whether or not the color domain is computed +with respect to the input data (here value) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as value and if set, cmin must +be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as value. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as value and if set, cmax must +be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.isosurface.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contour – plotly.graph_objects.isosurface.Contour +instance or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
flatshading – Determines whether or not normal smoothing is applied +to the meshes, creating meshes with an angular, low- +poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.isosurface.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.isosurface.Lighting +instance or dict with compatible properties
lightposition – plotly.graph_objects.isosurface.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
slices – plotly.graph_objects.isosurface.Slices +instance or dict with compatible properties
spaceframe – plotly.graph_objects.isosurface.Spaceframe +instance or dict with compatible properties
stream – plotly.graph_objects.isosurface.Stream +instance or dict with compatible properties
surface – plotly.graph_objects.isosurface.Surface +instance or dict with compatible properties
text – Sets the text elements associated with the vertices. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
value – Sets the 4th dimension (value) of the vertices.
valuesrc – Sets the source reference on Chart Studio Cloud for +value .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the X coordinates of the vertices on X axis.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the Y coordinates of the vertices on Y axis.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the Z coordinates of the vertices on Z axis.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Create and add a new image to the figure’s layout

Parameters

arg – instance of Image or dict with compatible properties
layer – Specifies whether images are drawn below or above +traces. When xref and yref are both set to paper, +image is drawn below the entire plot area.
name – When used in a template, named items are created in the +output figure in addition to any items the figure +already has in this array. You can modify these items +in the output figure by making your own item with +templateitemname matching this name alongside your +modifications (including visible: false or enabled: +false to hide it). Has no effect outside of a +template.
opacity – Sets the opacity of the image.
sizex – Sets the image container size horizontally. The image +will be sized based on the position value. When +xref is set to paper, units are sized relative to +the plot width.
sizey – Sets the image container size vertically. The image +will be sized based on the position value. When +yref is set to paper, units are sized relative to +the plot height.
sizing – Specifies which dimension of the image to constrain.
source – Specifies the URL of the image to be used. The URL must +be accessible from the domain where the plot code is +run, and can be either relative or absolute.
templateitemname – Used to refer to a named item in this array in the +template. Named items from the template will be created +even without a matching item in the input figure, but +you can modify one by making an item with +templateitemname matching its name, alongside your +modifications (including visible: false or enabled: +false to hide it). If there is no template or no +matching item, this item will be hidden unless you +explicitly show it with visible: true.
visible – Determines whether or not this image is visible.
x – Sets the image’s x position. When xref is set to +paper, units are sized relative to the plot height. +See xref for more info
xanchor – Sets the anchor for the x position
xref – Sets the images’s x coordinate axis. If set to a x axis +id (e.g. “x” or “x2”), the x position refers to an x +data coordinate If set to “paper”, the x position +refers to the distance from the left of plot in +normalized coordinates where 0 (1) corresponds to the +left (right).
y – Sets the image’s y position. When yref is set to +paper, units are sized relative to the plot height. +See yref for more info
yanchor – Sets the anchor for the y position.
yref – Sets the images’s y coordinate axis. If set to a y axis +id (e.g. “y” or “y2”), the y position refers to a y +data coordinate. If set to “paper”, the y position +refers to the distance from the bottom of the plot in +normalized coordinates where 0 (1) corresponds to the +bottom (top).
row – Subplot row for image
col – Subplot column for image
secondary_y – Whether to add image to secondary y-axis

Returns

Return type

FigureWidget

+ +

Add a new Mesh3d trace

Parameters

alphahull – Determines how the mesh surface triangles are derived +from the set of vertices (points) represented by the +x, y and z arrays, if the i, j, k arrays +are not supplied. For general use of mesh3d it is +preferred that i, j, k are supplied. If “-1”, +Delaunay triangulation is used, which is mainly +suitable if the mesh is a single, more or less layer +surface that is perpendicular to delaunayaxis. In +case the delaunayaxis intersects the mesh surface at +more than one point it will result triangles that are +very long in the dimension of delaunayaxis. If “>0”, +the alpha-shape algorithm is used. In this case, the +positive alphahull value signals the use of the +alpha-shape algorithm, _and_ its value acts as the +parameter for the mesh fitting. If 0, the convex-hull +algorithm is used. It is suitable for convex bodies or +if the intention is to enclose the x, y and z +point set into a convex hull.
autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here intensity) or +the bounds set in cmin and cmax Defaults to +false when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as intensity and if set, cmin +must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as intensity. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as intensity and if set, cmax +must be set as well.
color – Sets the color of the whole mesh
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.mesh3d.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contour – plotly.graph_objects.mesh3d.Contour instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
delaunayaxis – Sets the Delaunay axis, which is the axis that is +perpendicular to the surface of the Delaunay +triangulation. It has an effect if i, j, k are +not provided and alphahull is set to indicate +Delaunay triangulation.
facecolor – Sets the color of each face Overrides “color” and +“vertexcolor”.
facecolorsrc – Sets the source reference on Chart Studio Cloud for +facecolor .
flatshading – Determines whether or not normal smoothing is applied +to the meshes, creating meshes with an angular, low- +poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.mesh3d.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
i – A vector of vertex indices, i.e. integer values between +0 and the length of the vertex vectors, representing +the “first” vertex of a triangle. For example, {i[m], +j[m], k[m]} together represent face m (triangle m) in +the mesh, where i[m] = n points to the triplet +{x[n], y[n], z[n]} in the vertex arrays. Therefore, +each element in i represents a point in space, which +is the first vertex of a triangle.
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
intensity – Sets the intensity values for vertices or cells as +defined by intensitymode. It can be used for plotting +fields on meshes.
intensitymode – Determines the source of intensity values.
intensitysrc – Sets the source reference on Chart Studio Cloud for +intensity .
isrc – Sets the source reference on Chart Studio Cloud for i +.
j – A vector of vertex indices, i.e. integer values between +0 and the length of the vertex vectors, representing +the “second” vertex of a triangle. For example, {i[m], +j[m], k[m]} together represent face m (triangle m) in +the mesh, where j[m] = n points to the triplet +{x[n], y[n], z[n]} in the vertex arrays. Therefore, +each element in j represents a point in space, which +is the second vertex of a triangle.
jsrc – Sets the source reference on Chart Studio Cloud for j +.
k – A vector of vertex indices, i.e. integer values between +0 and the length of the vertex vectors, representing +the “third” vertex of a triangle. For example, {i[m], +j[m], k[m]} together represent face m (triangle m) in +the mesh, where k[m] = n points to the triplet +{x[n], y[n], z[n]} in the vertex arrays. Therefore, +each element in k represents a point in space, which +is the third vertex of a triangle.
ksrc – Sets the source reference on Chart Studio Cloud for k +.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.mesh3d.Lighting instance +or dict with compatible properties
lightposition – plotly.graph_objects.mesh3d.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.mesh3d.Stream instance or +dict with compatible properties
text – Sets the text elements associated with the vertices. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
vertexcolor – Sets the color of each vertex Overrides “color”. While +Red, green and blue colors are in the range of 0 and +255; in the case of having vertex color data in RGBA +format, the alpha color should be normalized to be +between 0 and 1.
vertexcolorsrc – Sets the source reference on Chart Studio Cloud for +vertexcolor .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the X coordinates of the vertices. The nth element +of vectors x, y and z jointly represent the X, Y +and Z coordinates of the nth vertex.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the Y coordinates of the vertices. The nth element +of vectors x, y and z jointly represent the X, Y +and Z coordinates of the nth vertex.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the Z coordinates of the vertices. The nth element +of vectors x, y and z jointly represent the X, Y +and Z coordinates of the nth vertex.
zcalendar – Sets the calendar system to use with z date data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Ohlc trace

Parameters

close – Sets the close values.
closesrc – Sets the source reference on Chart Studio Cloud for +close .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
decreasing – plotly.graph_objects.ohlc.Decreasing instance +or dict with compatible properties
high – Sets the high values.
highsrc – Sets the source reference on Chart Studio Cloud for +high .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.ohlc.Hoverlabel instance +or dict with compatible properties
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
increasing – plotly.graph_objects.ohlc.Increasing instance +or dict with compatible properties
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.ohlc.Line instance or +dict with compatible properties
low – Sets the low values.
lowsrc – Sets the source reference on Chart Studio Cloud for +low .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
open – Sets the open values.
opensrc – Sets the source reference on Chart Studio Cloud for +open .
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.ohlc.Stream instance or +dict with compatible properties
text – Sets hover text elements associated with each sample +point. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to this trace’s sample points.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
tickwidth – Sets the width of the open/close tick marks relative to +the “x” minimal interval.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates. If absent, linear coordinate +will be generated.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Parcats trace

Parallel categories diagram for multidimensional categorical +data.

Parameters

arrangement – Sets the drag interaction mode for categories and +dimensions. If perpendicular, the categories can only +move along a line perpendicular to the paths. If +freeform, the categories can freely move on the +plane. If fixed, the categories and dimensions are +stationary.
bundlecolors – Sort paths so that like colors are bundled together +within each category.
counts – The number of observations represented by each state. +Defaults to 1 so that each state represents one +observation
countssrc – Sets the source reference on Chart Studio Cloud for +counts .
dimensions – The dimensions (variables) of the parallel categories +diagram.
dimensiondefaults – When used in a template (as +layout.template.data.parcats.dimensiondefaults), sets +the default property values to use for elements of +parcats.dimensions
domain – plotly.graph_objects.parcats.Domain instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoveron – Sets the hover interaction mode for the parcats +diagram. If category, hover interaction take place +per category. If color, hover interactions take place +per color per category. If dimension, hover +interactions take place across all categories per +dimension.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables count, probability, +category, categorycount, colorcount and +bandcolorcount. Anything contained in tag <extra> +is displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
labelfont – Sets the font for the dimension labels.
line – plotly.graph_objects.parcats.Line instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
sortpaths – Sets the path sorting algorithm. If forward, sort +paths based on dimension categories from left to right. +If backward, sort paths based on dimensions +categories from right to left.
stream – plotly.graph_objects.parcats.Stream instance +or dict with compatible properties
tickfont – Sets the font for the category labels.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Parcoords trace

Parallel coordinates for multidimensional exploratory data +analysis. The samples are specified in dimensions. The colors +are set in line.color.

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dimensions – The dimensions (variables) of the parallel coordinates +chart. 2..60 dimensions are supported.
dimensiondefaults – When used in a template (as +layout.template.data.parcoords.dimensiondefaults), sets +the default property values to use for elements of +parcoords.dimensions
domain – plotly.graph_objects.parcoords.Domain instance +or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
labelangle – Sets the angle of the labels with respect to the +horizontal. For example, a tickangle of -90 draws the +labels vertically. Tilted labels with “labelangle” may +be positioned better inside margins when +labelposition is set to “bottom”.
labelfont – Sets the font for the dimension labels.
labelside – Specifies the location of the label. “top” positions +labels above, next to the title “bottom” positions +labels below the graph Tilted labels with “labelangle” +may be positioned better inside margins when +labelposition is set to “bottom”.
line – plotly.graph_objects.parcoords.Line instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
rangefont – Sets the font for the dimension range values.
stream – plotly.graph_objects.parcoords.Stream instance +or dict with compatible properties
tickfont – Sets the font for the dimension tick values.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Pie trace

A data visualized by the sectors of the pie is set in values. +The sector labels are set in labels. The sector colors are +set in marker.colors

Parameters

automargin – Determines whether outside text labels can push the +margins.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
direction – Specifies the direction at which succeeding sectors +follow one another.
dlabel – Sets the label step. See label0 for more info.
domain – plotly.graph_objects.pie.Domain instance or +dict with compatible properties
hole – Sets the fraction of the radius to cut out of the pie. +Use this to make a donut chart.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.pie.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables label, color, value, +percent and text. Anything contained in tag +<extra> is displayed in the secondary box, for +example “<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
insidetextorientation – Controls the orientation of the text inside chart +sectors. When set to “auto”, text may be oriented in +any direction in order to be as big as possible in the +middle of a sector. The “horizontal” option orients +text to be parallel with the bottom of the chart, and +may make text smaller in order to achieve that goal. +The “radial” option orients text along the radius of +the sector. The “tangential” option orients text +perpendicular to the radius of the sector.
label0 – Alternate to labels. Builds a numeric set of labels. +Use with dlabel where label0 is the starting label +and dlabel the step.
labels – Sets the sector labels. If labels entries are +duplicated, we sum associated values or simply count +occurrences if values is not provided. For other +array attributes (including color) we use the first +non-empty entry among all occurrences of the label.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.pie.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the +sector.
pull – Sets the fraction of larger radius to pull the sectors +out from the center. This can be a constant to pull all +slices apart from each other equally or an array to +highlight one or more slices.
pullsrc – Sets the source reference on Chart Studio Cloud for +pull .
rotation – Instead of the first slice starting at 12 o’clock, +rotate to some other angle.
scalegroup – If there are multiple pie charts that should be sized +according to their totals, link them by providing a +non-empty group id here shared by every trace in the +same group.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
sort – Determines whether or not the sectors are reordered +from largest to smallest.
stream – plotly.graph_objects.pie.Stream instance or +dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Specifies the location of the textinfo.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables label, +color, value, percent and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
title – plotly.graph_objects.pie.Title instance or +dict with compatible properties
titlefont – Deprecated: Please use pie.title.font instead. Sets the +font used for title. Note that the title’s font used +to be set by the now deprecated titlefont attribute.
titleposition – Deprecated: Please use pie.title.position instead. +Specifies the location of the title. Note that the +title’s position used to be set by the now deprecated +titleposition attribute.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values of the sectors. If omitted, we count +occurrences of each label.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Pointcloud trace

The data visualized as a point cloud set in x and y using +the WebGl plotting engine.

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.pointcloud.Hoverlabel +instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
indices – A sequential value, 0..n, supply it to avoid creating +this array inside plotting. If specified, it must be a +typed Int32Array array. Its length must be equal to +or greater than the number of points. For the best +performance and memory use, create one large indices +typed array that is guaranteed to be at least as long +as the largest number of points during use, and reuse +it on each Plotly.restyle() call.
indicessrc – Sets the source reference on Chart Studio Cloud for +indices .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.pointcloud.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.pointcloud.Stream +instance or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
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.
xbounds – Specify xbounds in the shape of [xMin, xMax] to +avoid looping through the `xy typed array. Use it in +conjunction with xy and ybounds for the performance +benefits.
xboundssrc – Sets the source reference on Chart Studio Cloud for +xbounds .
xsrc – Sets the source reference on Chart Studio Cloud for x +.
xy – Faster alternative to specifying x and y +separately. If supplied, it must be a typed +Float32Array array that represents points such that +xy[i * 2] = x[i] and xy[i * 2 + 1] = y[i]
xysrc – Sets the source reference on Chart Studio Cloud for xy +.
y – Sets the y coordinates.
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.
ybounds – Specify ybounds in the shape of [yMin, yMax] to +avoid looping through the `xy typed array. Use it in +conjunction with xy and xbounds for the performance +benefits.
yboundssrc – Sets the source reference on Chart Studio Cloud for +ybounds .
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Sankey trace

Parameters

arrangement – If value is snap (the default), the node arrangement +is assisted by automatic snapping of elements to +preserve space between nodes specified via nodepad. +If value is perpendicular, the nodes can only move +along a line perpendicular to the flow. If value is +freeform, the nodes can freely move on the plane. If +value is fixed, the nodes are stationary.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.sankey.Domain instance or +dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired. Note that this attribute is +superseded by node.hoverinfo and node.hoverinfo for +nodes and links respectively.
hoverlabel – plotly.graph_objects.sankey.Hoverlabel +instance or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
link – The links of the Sankey plot.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
node – The nodes of the Sankey plot.
orientation – Sets the orientation of the Sankey diagram.
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
stream – plotly.graph_objects.sankey.Stream instance or +dict with compatible properties
textfont – Sets the font for node labels
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
valueformat – Sets the value formatting rule using d3 formatting +mini-language which is similar to those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
valuesuffix – Adds a unit to follow the value in the hover tooltip. +Add a space if a separation is necessary from the +value.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Scatter trace

Parameters

cliponaxis – Determines whether or not markers and text nodes are +clipped about the subplot axes. To show markers and +text nodes above axis lines and tick labels, make sure +to set xaxis.layer and yaxis.layer to below +traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.scatter.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.scatter.ErrorY instance +or dict with compatible properties
fill – Sets the area to fill with a solid color. Defaults to +“none” unless this trace is stacked, then it gets +“tonexty” (“tonextx”) if orientation is “v” (“h”) Use +with fillcolor if not “none”. “tozerox” and “tozeroy” +fill to x=0 and y=0 respectively. “tonextx” and +“tonexty” fill between the endpoints of this trace and +the endpoints of the trace before it, connecting those +endpoints with straight lines (to make a stacked area +graph); if there is no trace before it, they behave +like “tozerox” and “tozeroy”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other. Traces in a stackgroup will only fill to (or +be filled to) other traces in the same group. With +multiple `stackgroup`s or some traces stacked and some +not, if fill-linked traces are not already consecutive, +the later ones will be pushed down in the drawing +order.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
groupnorm – Only relevant when stackgroup is used, and only the +first groupnorm found in the stackgroup will be +used - including if visible is “legendonly” but not +if it is false. Sets the normalization for the sum of +this stackgroup. With “fraction”, the value of each +trace at each location is divided by the sum of all +trace values at that location. “percent” is the same +but multiplied by 100 to show percentages. If there are +multiple subplots, or multiple `stackgroup`s on one +subplot, each will be normalized within its own set.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatter.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatter.Line instance or +dict with compatible properties
marker – plotly.graph_objects.scatter.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
orientation – Only relevant 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.
r – r coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the radial +coordinatesfor legacy polar chart only.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.scatter.Selected instance +or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stackgaps – Only relevant when stackgroup is used, and only the +first stackgaps found in the stackgroup will be +used - including if visible is “legendonly” but not +if it is false. Determines how we handle locations at +which other traces in this group have data but this one +does not. With infer zero we insert a zero at these +locations. With “interpolate” we linearly interpolate +between existing values, and extrapolate a constant +beyond the existing values.
stackgroup – Set several scatter traces (on the same subplot) to the +same stackgroup in order to add their y values (or +their x values if orientation is “h”). If blank or +omitted this trace will not be stacked. Stacking also +turns fill on by default, using “tonexty” (“tonextx”) +if orientation is “h” (“v”) and sets the default +mode to “lines” irrespective of point count. You can +only stack on a numeric (linear or log) axis. Traces in +a stackgroup will only fill to (or be filled to) +other traces in the same group. With multiple +`stackgroup`s or some traces stacked and some not, if +fill-linked traces are not already consecutive, the +later ones will be pushed down in the drawing order.
stream – plotly.graph_objects.scatter.Stream instance +or dict with compatible properties
t – t coordinates in scatter traces are deprecated!Please +switch to the “scatterpolar” trace type.Sets the +angular coordinatesfor legacy polar chart only.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
tsrc – Sets the source reference on Chart Studio Cloud for t +.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatter.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Scatter3d trace

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
error_x – plotly.graph_objects.scatter3d.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.scatter3d.ErrorY instance +or dict with compatible properties
error_z – plotly.graph_objects.scatter3d.ErrorZ instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatter3d.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets text elements associated with each (x,y,z) +triplet. If a single string, the same string appears +over all the data points. If an array of string, the +items are mapped in order to the this trace’s (x,y,z) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatter3d.Line instance +or dict with compatible properties
marker – plotly.graph_objects.scatter3d.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
projection – plotly.graph_objects.scatter3d.Projection +instance or dict with compatible properties
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatter3d.Stream instance +or dict with compatible properties
surfaceaxis – If “-1”, the scatter points are not fill with a surface +If 0, 1, 2, the scatter points are filled with a +Delaunay surface about the x, y, z respectively.
surfacecolor – Sets the surface fill color.
text – Sets text elements associated with each (x,y,z) +triplet. If a single string, the same string appears +over all the data points. If an array of string, the +items are mapped in order to the this trace’s (x,y,z) +coordinates. If trace hoverinfo contains a “text” +flag and “hovertext” is not set, these elements will be +seen in the hover labels.
textfont – plotly.graph_objects.scatter3d.Textfont +instance or dict with compatible properties
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with z date data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Scattercarpet trace

Plots a scatter trace on either the first carpet axis or the +carpet axis with a matching carpet attribute.

Parameters

a – Sets the a-axis coordinates.
asrc – Sets the source reference on Chart Studio Cloud for a +.
b – Sets the b-axis coordinates.
bsrc – Sets the source reference on Chart Studio Cloud for b +.
carpet – An identifier for this carpet, so that scattercarpet +and contourcarpet traces can specify a carpet plot on +which they lie
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. scatterternary has a subset +of the options available to scatter. “toself” connects +the endpoints of the trace (or each segment of the +trace if it has gaps) into a closed shape. “tonext” +fills the space between two traces if one completely +encloses the other (eg consecutive contour lines), and +behaves like “toself” if there is no trace before it. +“tonext” should not be used if one trace does not +enclose the other.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattercarpet.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (a,b) +point. If a single string, the same string appears over +all the data points. If an array of strings, the items +are mapped in order to the the data points in (a,b). To +be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattercarpet.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scattercarpet.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattercarpet.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattercarpet.Stream +instance or dict with compatible properties
text – Sets text elements associated with each (a,b) point. If +a single string, the same string appears over all the +data points. If an array of strings, the items are +mapped in order to the the data points in (a,b). If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables a, b and +text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattercarpet.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Scattergeo trace

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
featureidkey – Sets the key in GeoJSON features which is used as id to +match the items included in the locations array. Only +has an effect when geojson is set. Support nested +property, for example “properties.name”.
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
geo – Sets a reference between this trace’s geospatial +coordinates and a geographic map. If “geo” (the default +value), the geospatial coordinates refer to +layout.geo. If “geo2”, the geospatial coordinates +refer to layout.geo2, and so on.
geojson – Sets optional GeoJSON data associated with this trace. +If not given, the features on the base map are used +when locations is set. It can be set as a valid +GeoJSON object or as a URL string. Note that we only +accept GeoJSONs of type “FeatureCollection” or +“Feature” with geometries of type “Polygon” or +“MultiPolygon”.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattergeo.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (lon,lat) +pair or item in locations. If a single string, the +same string appears over all the data points. If an +array of string, the items are mapped in order to the +this trace’s (lon,lat) or locations coordinates. To +be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for +lat .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattergeo.Line instance +or dict with compatible properties
locationmode – Determines the set of locations used to match entries +in locations to regions on the map. Values “ISO-3”, +“USA-states”, country names correspond to features on +the base map and value “geojson-id” corresponds to +features from a custom GeoJSON linked to the geojson +attribute.
locations – Sets the coordinates via location IDs or names. +Coordinates correspond to the centroid of each location +given. See locationmode for more info.
locationssrc – Sets the source reference on Chart Studio Cloud for +locations .
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for +lon .
marker – plotly.graph_objects.scattergeo.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattergeo.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattergeo.Stream +instance or dict with compatible properties
text – Sets text elements associated with each (lon,lat) pair +or item in locations. If a single string, the same +string appears over all the data points. If an array of +string, the items are mapped in order to the this +trace’s (lon,lat) or locations coordinates. If trace +hoverinfo contains a “text” flag and “hovertext” is +not set, these elements will be seen in the hover +labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables lat, lon, +location and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattergeo.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Scattergl trace

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
error_x – plotly.graph_objects.scattergl.ErrorX instance +or dict with compatible properties
error_y – plotly.graph_objects.scattergl.ErrorY instance +or dict with compatible properties
fill – Sets the area to fill with a solid color. Defaults to +“none” unless this trace is stacked, then it gets +“tonexty” (“tonextx”) if orientation is “v” (“h”) Use +with fillcolor if not “none”. “tozerox” and “tozeroy” +fill to x=0 and y=0 respectively. “tonextx” and +“tonexty” fill between the endpoints of this trace and +the endpoints of the trace before it, connecting those +endpoints with straight lines (to make a stacked area +graph); if there is no trace before it, they behave +like “tozerox” and “tozeroy”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other. Traces in a stackgroup will only fill to (or +be filled to) other traces in the same group. With +multiple `stackgroup`s or some traces stacked and some +not, if fill-linked traces are not already consecutive, +the later ones will be pushed down in the drawing +order.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattergl.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattergl.Line instance +or dict with compatible properties
marker – plotly.graph_objects.scattergl.Marker instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattergl.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattergl.Stream instance +or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattergl.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Scattermapbox trace

The data visualized as scatter point, lines or marker symbols +on a Mapbox GL geographic map is provided by longitude/latitude +pairs in lon and lat.

Parameters

below – Determines if this scattermapbox trace’s layers are to +be inserted before the layer with the specified ID. By +default, scattermapbox layers are inserted above all +the base layers. To place the scattermapbox layers +above every other layer, set below to “’‘”.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scattermapbox.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (lon,lat) +pair If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (lon,lat) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
lat – Sets the latitude coordinates (in degrees North).
latsrc – Sets the source reference on Chart Studio Cloud for +lat .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scattermapbox.Line +instance or dict with compatible properties
lon – Sets the longitude coordinates (in degrees East).
lonsrc – Sets the source reference on Chart Studio Cloud for +lon .
marker – plotly.graph_objects.scattermapbox.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scattermapbox.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scattermapbox.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a mapbox subplot. If “mapbox” (the default value), +the data refer to layout.mapbox. If “mapbox2”, the +data refer to layout.mapbox2, and so on.
text – Sets text elements associated with each (lon,lat) pair +If a single string, the same string appears over all +the data points. If an array of string, the items are +mapped in order to the this trace’s (lon,lat) +coordinates. If trace hoverinfo contains a “text” +flag and “hovertext” is not set, these elements will be +seen in the hover labels.
textfont – Sets the icon text font (color=mapbox.layer.paint.text- +color, size=mapbox.layer.layout.text-size). Has an +effect only when type is set to “symbol”.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables lat, lon +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scattermapbox.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Scatterpolar trace

Parameters

cliponaxis – Determines whether or not markers and text nodes are +clipped about the subplot axes. To show markers and +text nodes above axis lines and tick labels, make sure +to set xaxis.layer and yaxis.layer to below +traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the +dtheta step equals the subplot’s period divided by +the length of the r coordinates.
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. scatterpolar has a subset of +the options available to scatter. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatterpolar.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatterpolar.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scatterpolar.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r +coordinates. Use with dr where r0 is the starting +coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.scatterpolar.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatterpolar.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a polar subplot. If “polar” (the default value), +the data refer to layout.polar. If “polar2”, the data +refer to layout.polar2, and so on.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables r, theta +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the +starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for +theta .
thetaunit – Sets the unit of input “theta” values. Has an effect +only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterpolar.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Scatterpolargl trace

Parameters

connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
dr – Sets the r coordinate step.
dtheta – Sets the theta coordinate step. By default, the +dtheta step equals the subplot’s period divided by +the length of the r coordinates.
fill – Sets the area to fill with a solid color. Defaults to +“none” unless this trace is stacked, then it gets +“tonexty” (“tonextx”) if orientation is “v” (“h”) Use +with fillcolor if not “none”. “tozerox” and “tozeroy” +fill to x=0 and y=0 respectively. “tonextx” and +“tonexty” fill between the endpoints of this trace and +the endpoints of the trace before it, connecting those +endpoints with straight lines (to make a stacked area +graph); if there is no trace before it, they behave +like “tozerox” and “tozeroy”. “toself” connects the +endpoints of the trace (or each segment of the trace if +it has gaps) into a closed shape. “tonext” fills the +space between two traces if one completely encloses the +other (eg consecutive contour lines), and behaves like +“toself” if there is no trace before it. “tonext” +should not be used if one trace does not enclose the +other. Traces in a stackgroup will only fill to (or +be filled to) other traces in the same group. With +multiple `stackgroup`s or some traces stacked and some +not, if fill-linked traces are not already consecutive, +the later ones will be pushed down in the drawing +order.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatterpolargl.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatterpolargl.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scatterpolargl.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
r – Sets the radial coordinates
r0 – Alternate to r. Builds a linear space of r +coordinates. Use with dr where r0 is the starting +coordinate and dr the step.
rsrc – Sets the source reference on Chart Studio Cloud for r +.
selected – plotly.graph_objects.scatterpolargl.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatterpolargl.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a polar subplot. If “polar” (the default value), +the data refer to layout.polar. If “polar2”, the data +refer to layout.polar2, and so on.
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables r, theta +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
theta – Sets the angular coordinates
theta0 – Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the +starting coordinate and dtheta the step.
thetasrc – Sets the source reference on Chart Studio Cloud for +theta .
thetaunit – Sets the unit of input “theta” values. Has an effect +only when on “linear” angular axes.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterpolargl.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Scatterternary trace

Provides similar functionality to the “scatter” type but on a +ternary phase diagram. The data is provided by at least two +arrays out of a, b, c triplets.

Parameters

a – Sets the quantity of component a in each data point. +If a, b, and c are all provided, they need not be +normalized, only the relative values matter. If only +two arrays are provided they must be normalized to +match ternary.sum.
asrc – Sets the source reference on Chart Studio Cloud for a +.
b – Sets the quantity of component a in each data point. +If a, b, and c are all provided, they need not be +normalized, only the relative values matter. If only +two arrays are provided they must be normalized to +match ternary.sum.
bsrc – Sets the source reference on Chart Studio Cloud for b +.
c – Sets the quantity of component a in each data point. +If a, b, and c are all provided, they need not be +normalized, only the relative values matter. If only +two arrays are provided they must be normalized to +match ternary.sum.
cliponaxis – Determines whether or not markers and text nodes are +clipped about the subplot axes. To show markers and +text nodes above axis lines and tick labels, make sure +to set xaxis.layer and yaxis.layer to below +traces.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the provided data arrays are connected.
csrc – Sets the source reference on Chart Studio Cloud for c +.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fill – Sets the area to fill with a solid color. Use with +fillcolor if not “none”. scatterternary has a subset +of the options available to scatter. “toself” connects +the endpoints of the trace (or each segment of the +trace if it has gaps) into a closed shape. “tonext” +fills the space between two traces if one completely +encloses the other (eg consecutive contour lines), and +behaves like “toself” if there is no trace before it. +“tonext” should not be used if one trace does not +enclose the other.
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.scatterternary.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual points +(markers or line points) or do they highlight filled +regions? If the fill is “toself” or “tonext” and there +are no markers or text, then the default is “fills”, +otherwise it is “points”.
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (a,b,c) +point. If a single string, the same string appears over +all the data points. If an array of strings, the items +are mapped in order to the the data points in (a,b,c). +To be seen, trace hoverinfo must contain a “text” +flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.scatterternary.Line +instance or dict with compatible properties
marker – plotly.graph_objects.scatterternary.Marker +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
mode – Determines the drawing mode for this scatter trace. If +the provided mode includes “text” then the text +elements appear at the coordinates. Otherwise, the +text elements appear on hover. If there are less than +20 points and the trace is not stacked then the default +is “lines+markers”. Otherwise, “lines”.
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.scatterternary.Selected +instance or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.scatterternary.Stream +instance or dict with compatible properties
subplot – Sets a reference between this trace’s data coordinates +and a ternary subplot. If “ternary” (the default +value), the data refer to layout.ternary. If +“ternary2”, the data refer to layout.ternary2, and so +on.
sum – The number each triplet should sum to, if only two of +a, b, and c are provided. This overrides +ternary.sum to normalize this specific trace, but +does not affect the values displayed on the axes. 0 (or +missing) means to use ternary.sum
text – Sets text elements associated with each (a,b,c) point. +If a single string, the same string appears over all +the data points. If an array of strings, the items are +mapped in order to the the data points in (a,b,c). If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textfont – Sets the text font.
textposition – Sets the positions of the text elements with respects +to the (x,y) coordinates.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables a, b, c +and text.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.scatterternary.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Create and add a new shape to the figure’s layout

Parameters

arg – instance of Shape or dict with compatible properties
fillcolor – Sets the color filling the shape’s interior.
layer – Specifies whether shapes are drawn below or above +traces.
line – plotly.graph_objects.layout.shape.Line +instance or dict with compatible properties
name – When used in a template, named items are created in the +output figure in addition to any items the figure +already has in this array. You can modify these items +in the output figure by making your own item with +templateitemname matching this name alongside your +modifications (including visible: false or enabled: +false to hide it). Has no effect outside of a +template.
opacity – Sets the opacity of the shape.
path – For type “path” - a valid SVG path with the pixel +values replaced by data values in +xsizemode/ysizemode being “scaled” and taken +unmodified as pixels relative to xanchor and +yanchor in case of “pixel” size mode. There are a few +restrictions / quirks only absolute instructions, not +relative. So the allowed segments are: M, L, H, V, Q, +C, T, S, and Z arcs (A) are not allowed because radius +rx and ry are relative. In the future we could consider +supporting relative commands, but we would have to +decide on how to handle date and log axes. Note that +even as is, Q and C Bezier paths that are smooth on +linear axes may not be smooth on log, and vice versa. +no chained “polybezier” commands - specify the segment +type for each one. On category axes, values are numbers +scaled to the serial numbers of categories because +using the categories themselves there would be no way +to describe fractional positions On data axes: because +space and T are both normal components of path strings, +we can’t use either to separate date from time parts. +Therefore we’ll use underscore for this purpose: +2015-02-21_13:45:56.789
templateitemname – Used to refer to a named item in this array in the +template. Named items from the template will be created +even without a matching item in the input figure, but +you can modify one by making an item with +templateitemname matching its name, alongside your +modifications (including visible: false or enabled: +false to hide it). If there is no template or no +matching item, this item will be hidden unless you +explicitly show it with visible: true.
type – Specifies the shape type to be drawn. If “line”, a line +is drawn from (x0,`y0`) to (x1,`y1`) with respect +to the axes’ sizing mode. If “circle”, a circle is +drawn from ((x0`+`x1)/2, (y0`+`y1)/2)) with radius +(|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with +respect to the axes’ sizing mode. If “rect”, a +rectangle is drawn linking (x0,`y0`), (x1,`y0`), +(x1,`y1`), (x0,`y1`), (x0,`y0`) with respect to +the axes’ sizing mode. If “path”, draw a custom SVG +path using path. with respect to the axes’ sizing +mode.
visible – Determines whether or not this shape is visible.
x0 – Sets the shape’s starting x position. See type and +xsizemode for more info.
x1 – Sets the shape’s end x position. See type and +xsizemode for more info.
xanchor – Only relevant in conjunction with xsizemode set to +“pixel”. Specifies the anchor point on the x axis to +which x0, x1 and x coordinates within path are +relative to. E.g. useful to attach a pixel sized shape +to a certain data value. No effect when xsizemode not +set to “pixel”.
xref – Sets the shape’s x coordinate axis. If set to an x axis +id (e.g. “x” or “x2”), the x position refers to an x +coordinate. If set to “paper”, the x position refers +to the distance from the left side of the plotting area +in normalized coordinates where 0 (1) corresponds to +the left (right) side. If the axis type is “log”, +then you must take the log of your desired range. If +the axis type is “date”, then you must convert the +date to unix time in milliseconds.
xsizemode – Sets the shapes’s sizing mode along the x axis. If set +to “scaled”, x0, x1 and x coordinates within path +refer to data values on the x axis or a fraction of the +plot area’s width (xref set to “paper”). If set to +“pixel”, xanchor specifies the x position in terms of +data or plot fraction but x0, x1 and x coordinates +within path are pixels relative to xanchor. This +way, the shape can have a fixed width while maintaining +a position relative to data or plot fraction.
y0 – Sets the shape’s starting y position. See type and +ysizemode for more info.
y1 – Sets the shape’s end y position. See type and +ysizemode for more info.
yanchor – Only relevant in conjunction with ysizemode set to +“pixel”. Specifies the anchor point on the y axis to +which y0, y1 and y coordinates within path are +relative to. E.g. useful to attach a pixel sized shape +to a certain data value. No effect when ysizemode not +set to “pixel”.
yref – Sets the annotation’s y coordinate axis. If set to an y +axis id (e.g. “y” or “y2”), the y position refers to +an y coordinate If set to “paper”, the y position +refers to the distance from the bottom of the plotting +area in normalized coordinates where 0 (1) corresponds +to the bottom (top).
ysizemode – Sets the shapes’s sizing mode along the y axis. If set +to “scaled”, y0, y1 and y coordinates within path +refer to data values on the y axis or a fraction of the +plot area’s height (yref set to “paper”). If set to +“pixel”, yanchor specifies the y position in terms of +data or plot fraction but y0, y1 and y coordinates +within path are pixels relative to yanchor. This +way, the shape can have a fixed height while +maintaining a position relative to data or plot +fraction.
row – Subplot row for shape
col – Subplot column for shape
secondary_y – Whether to add shape to secondary y-axis

Returns

Return type

FigureWidget

+ +

Add a new Splom trace

Parameters

customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
diagonal – plotly.graph_objects.splom.Diagonal instance +or dict with compatible properties
dimensions – A tuple of +plotly.graph_objects.splom.Dimension instances +or dicts with compatible properties
dimensiondefaults – When used in a template (as +layout.template.data.splom.dimensiondefaults), sets the +default property values to use for elements of +splom.dimensions
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.splom.Hoverlabel instance +or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
marker – plotly.graph_objects.splom.Marker instance or +dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
selected – plotly.graph_objects.splom.Selected instance +or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showlowerhalf – Determines whether or not subplots on the lower half +from the diagonal are displayed.
showupperhalf – Determines whether or not subplots on the upper half +from the diagonal are displayed.
stream – plotly.graph_objects.splom.Stream instance or +dict with compatible properties
text – Sets text elements associated with each (x,y) pair to +appear on hover. If a single string, the same string +appears over all the data points. If an array of +string, the items are mapped in order to the this +trace’s (x,y) coordinates.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.splom.Unselected instance +or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
xaxes – Sets the list of x axes corresponding to dimensions of +this splom trace. By default, a splom will match the +first N xaxes where N is the number of input +dimensions. Note that, in case where diagonal.visible +is false and showupperhalf or showlowerhalf is +false, this splom trace will generate one less x-axis +and one less y-axis.
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.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Streamtube trace

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here u/v/w norm) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmin +must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as u/v/w norm. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as u/v/w norm and if set, cmax +must be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.streamtube.ColorBar +instance or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.streamtube.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables tubex, tubey, tubez, +tubeu, tubev, tubew, norm and divergence. +Anything contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.streamtube.Lighting +instance or dict with compatible properties
lightposition – plotly.graph_objects.streamtube.Lightposition +instance or dict with compatible properties
maxdisplayed – The maximum number of displayed segments in a +streamtube.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
sizeref – The scaling factor for the streamtubes. The default is +1, which avoids two max divergence tubes from touching +at adjacent starting positions.
starts – plotly.graph_objects.streamtube.Starts +instance or dict with compatible properties
stream – plotly.graph_objects.streamtube.Stream +instance or dict with compatible properties
text – Sets a text element associated with this trace. If +trace hoverinfo contains a “text” flag, this text +element will be seen in all hover labels. Note that +streamtube traces do not support array text values.
u – Sets the x components of the vector field.
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
usrc – Sets the source reference on Chart Studio Cloud for u +.
v – Sets the y components of the vector field.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
vsrc – Sets the source reference on Chart Studio Cloud for v +.
w – Sets the z components of the vector field.
wsrc – Sets the source reference on Chart Studio Cloud for w +.
x – Sets the x coordinates of the vector field.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates of the vector field.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates of the vector field.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Sunburst trace

Visualize hierarchal data spanning outward radially from root +to leaves. The sunburst sectors are determined by the entries +in “labels” or “ids” and in “parents”.

Parameters

branchvalues – Determines how the items in values are summed. When +set to “total”, items in values are taken to be value +of all its descendants. When set to “remainder”, items +in values corresponding to the root and the branches +sectors are taken to be the extra part not part of the +sum of the values at their leaves.
count – Determines default for values when it is not +provided, by inferring a 1 for each of the “leaves” +and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.sunburst.Domain instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.sunburst.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables currentPath, root, +entry, percentRoot, percentEntry and +percentParent. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
insidetextorientation – Controls the orientation of the text inside chart +sectors. When set to “auto”, text may be oriented in +any direction in order to be as big as possible in the +middle of a sector. The “horizontal” option orients +text to be parallel with the bottom of the chart, and +may make text smaller in order to achieve that goal. +The “radial” option orients text along the radius of +the sector. The “tangential” option orients text +perpendicular to the radius of the sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
leaf – plotly.graph_objects.sunburst.Leaf instance or +dict with compatible properties
level – Sets the level from which this trace hierarchy is +rendered. Set level to '' to start from the root +node in the hierarchy. Must be an “id” if ids is +filled in, otherwise plotly attempts to find a matching +item in labels.
marker – plotly.graph_objects.sunburst.Marker instance +or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given +level. Set maxdepth to “-1” to render all the +levels in the hierarchy.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the +sector. This option refers to the root of the hierarchy +presented at the center of a sunburst graph. Please +note that if a hierarchy has multiple root nodes, this +option won’t have any effect and insidetextfont would +be used.
parents – Sets the parent sectors for each of the sectors. Empty +string items ‘’ are understood to reference the root +node in the hierarchy. If ids is filled, parents +items are understood to be “ids” themselves. When ids +is not set, plotly attempts to find matching items in +labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for +parents .
stream – plotly.graph_objects.sunburst.Stream instance +or dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables +currentPath, root, entry, percentRoot, +percentEntry, percentParent, label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values associated with each of the sectors. +Use with branchvalues to determine how the values are +summed.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Surface trace

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
cauto – Determines whether or not the color domain is computed +with respect to the input data (here z or surfacecolor) +or the bounds set in cmin and cmax Defaults to +false when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as z or surfacecolor and if set, +cmin must be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as z or surfacecolor. +Has no effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as z or surfacecolor and if set, +cmax must be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.surface.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
connectgaps – Determines whether or not gaps (i.e. {nan} or missing +values) in the z data are filled in.
contours – plotly.graph_objects.surface.Contours instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
hidesurface – Determines whether or not a surface is drawn. For +example, set hidesurface to False contours.x.show +to True and contours.y.show to True to draw a wire +frame plot.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.surface.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.surface.Lighting instance +or dict with compatible properties
lightposition – plotly.graph_objects.surface.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an +array containing arrays mapping a normalized value to +an opacity value. At minimum, a mapping for the lowest +(0) and highest (1) values are required. For example, +[[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower +values would have higher opacity values and those in +the middle would be more transparent Alternatively, +opacityscale may be a palette name string of the +following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. +The default is ‘uniform’.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
stream – plotly.graph_objects.surface.Stream instance +or dict with compatible properties
surfacecolor – Sets the surface color values, used for setting a color +scale independent of z.
surfacecolorsrc – Sets the source reference on Chart Studio Cloud for +surfacecolor .
text – Sets the text elements associated with each z value. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the x coordinates.
xcalendar – Sets the calendar system to use with x date data.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with y date data.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with z date data.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Table trace

Parameters

cells – plotly.graph_objects.table.Cells instance or +dict with compatible properties
columnorder – Specifies the rendered order of the data columns; for +example, a value 2 at position 0 means that column +index 0 in the data will be rendered as the third +column, as columns have an index base of zero.
columnordersrc – Sets the source reference on Chart Studio Cloud for +columnorder .
columnwidth – The width of columns expressed as a ratio. Columns fill +the available width in proportion of their specified +column widths.
columnwidthsrc – Sets the source reference on Chart Studio Cloud for +columnwidth .
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.table.Domain instance or +dict with compatible properties
header – plotly.graph_objects.table.Header instance or +dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.table.Hoverlabel instance +or dict with compatible properties
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
stream – plotly.graph_objects.table.Stream instance or +dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Treemap trace

Visualize hierarchal data from leaves (and/or outer branches) +towards root with rectangles. The treemap sectors are +determined by the entries in “labels” or “ids” and in +“parents”.

Parameters

branchvalues – Determines how the items in values are summed. When +set to “total”, items in values are taken to be value +of all its descendants. When set to “remainder”, items +in values corresponding to the root and the branches +sectors are taken to be the extra part not part of the +sum of the values at their leaves.
count – Determines default for values when it is not +provided, by inferring a 1 for each of the “leaves” +and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
domain – plotly.graph_objects.treemap.Domain instance +or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.treemap.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables currentPath, root, +entry, percentRoot, percentEntry and +percentParent. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each sector. +If a single string, the same string appears for all +data points. If an array of string, the items are +mapped in order of this trace’s sectors. To be seen, +trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
insidetextfont – Sets the font used for textinfo lying inside the +sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for +labels .
level – Sets the level from which this trace hierarchy is +rendered. Set level to '' to start from the root +node in the hierarchy. Must be an “id” if ids is +filled in, otherwise plotly attempts to find a matching +item in labels.
marker – plotly.graph_objects.treemap.Marker instance +or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given +level. Set maxdepth to “-1” to render all the +levels in the hierarchy.
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the +sector. This option refers to the root of the hierarchy +presented on top left corner of a treemap graph. Please +note that if a hierarchy has multiple root nodes, this +option won’t have any effect and insidetextfont would +be used.
parents – Sets the parent sectors for each of the sectors. Empty +string items ‘’ are understood to reference the root +node in the hierarchy. If ids is filled, parents +items are understood to be “ids” themselves. When ids +is not set, plotly attempts to find matching items in +labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for +parents .
pathbar – plotly.graph_objects.treemap.Pathbar instance +or dict with compatible properties
stream – plotly.graph_objects.treemap.Stream instance +or dict with compatible properties
text – Sets text elements associated with each sector. If +trace textinfo contains a “text” flag, these elements +will be seen on the chart. If trace hoverinfo +contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Sets the positions of the text elements.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables +currentPath, root, entry, percentRoot, +percentEntry, percentParent, label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
tiling – plotly.graph_objects.treemap.Tiling instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
values – Sets the values associated with each of the sectors. +Use with branchvalues to determine how the values are +summed.
valuessrc – Sets the source reference on Chart Studio Cloud for +values .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Violin trace

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
bandwidth – Sets the bandwidth used to compute the kernel density +estimate. By default, the bandwidth is determined by +Silverman’s rule of thumb.
box – plotly.graph_objects.violin.Box instance or +dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
fillcolor – Sets the fill color. Defaults to a half-transparent +variant of the line color, marker color, or marker line +color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.violin.Hoverlabel +instance or dict with compatible properties
hoveron – Do the hover effects highlight individual violins or +sample points or the kernel density estimate or any +combination of them?
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
jitter – Sets the amount of jitter in the sample points drawn. +If 0, the sample points align along the distribution +axis. If 1, the sample points are drawn in a random +jitter of width equal to the width of the violins.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
line – plotly.graph_objects.violin.Line instance or +dict with compatible properties
marker – plotly.graph_objects.violin.Marker instance or +dict with compatible properties
meanline – plotly.graph_objects.violin.Meanline instance +or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover. For violin traces, the name +will also be used for the position coordinate, if x +and x0 (y and y0 if horizontal) are missing and +the position axis is categorical. Note that the trace +name is also used as a default value for attribute +scalegroup (please see its description for details).
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the violin(s). If “v” (“h”), +the distribution is visualized along the vertical +(horizontal).
pointpos – Sets the position of the sample points in relation to +the violins. If 0, the sample points are places over +the center of the violins. Positive (negative) values +correspond to positions to the right (left) for +vertical violins and above (below) for horizontal +violins.
points – If “outliers”, only the sample points lying outside the +whiskers are shown If “suspectedoutliers”, the outlier +points are shown and points either less than 4*Q1-3*Q3 +or greater than 4*Q3-3*Q1 are highlighted (see +outliercolor) If “all”, all sample points are shown +If False, only the violins are shown with no sample +points. Defaults to “suspectedoutliers” when +marker.outliercolor or marker.line.outliercolor is +set, otherwise defaults to “outliers”.
scalegroup – If there are multiple violins that should be sized +according to to some metric (see scalemode), link +them by providing a non-empty group id here shared by +every trace in the same group. If a violin’s width is +undefined, scalegroup will default to the trace’s +name. In this case, violins with the same names will be +linked together
scalemode – Sets the metric by which the width of each violin is +determined.”width” means each violin has the same (max) +width*count* means the violins are scaled by the number +of sample points makingup each violin.
selected – plotly.graph_objects.violin.Selected instance +or dict with compatible properties
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
side – Determines on which side of the position value the +density function making up one half of a violin is +plotted. Useful when comparing two violin traces under +“overlay” mode, where one trace has side set to +“positive” and the other to “negative”.
span – Sets the span in data space for which the density +function will be computed. Has an effect only when +spanmode is set to “manual”.
spanmode – Sets the method by which the span in data space where +the density function will be computed. “soft” means the +span goes from the sample’s minimum value minus two +bandwidths to the sample’s maximum value plus two +bandwidths. “hard” means the span goes from the +sample’s minimum to its maximum value. For custom span +settings, use mode “manual” and fill in the span +attribute.
stream – plotly.graph_objects.violin.Stream instance or +dict with compatible properties
text – Sets the text elements associated with each sample +value. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
unselected – plotly.graph_objects.violin.Unselected +instance or dict with compatible properties
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the width of the violin in data coordinates. If 0 +(default value) the width is automatically selected +based on the positions of other violin traces in the +same subplot.
x – Sets the x sample data or coordinates. See overview for +more info.
x0 – Sets the x coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y sample data or coordinates. See overview for +more info.
y0 – Sets the y coordinate for single-box traces or the +starting coordinate for multi-box traces set using +q1/median/q3. See overview for more info.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

Add a new Volume trace

Parameters

autocolorscale – Determines whether the colorscale is a default palette +(autocolorscale: true) or the palette determined by +colorscale. In case colorscale is unspecified or +autocolorscale is true, the default palette will be +chosen according to whether numbers in the color +array are all positive, all negative or mixed.
caps – plotly.graph_objects.volume.Caps instance or +dict with compatible properties
cauto – Determines whether or not the color domain is computed +with respect to the input data (here value) or the +bounds set in cmin and cmax Defaults to false +when cmin and cmax are set by the user.
cmax – Sets the upper bound of the color domain. Value should +have the same units as value and if set, cmin must +be set as well.
cmid – Sets the mid-point of the color domain by scaling +cmin and/or cmax to be equidistant to this point. +Value should have the same units as value. Has no +effect when cauto is false.
cmin – Sets the lower bound of the color domain. Value should +have the same units as value and if set, cmax must +be set as well.
coloraxis – Sets a reference to a shared color axis. References to +these shared color axes are “coloraxis”, “coloraxis2”, +“coloraxis3”, etc. Settings for these shared color axes +are set in the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple color +scales can be linked to the same color axis.
colorbar – plotly.graph_objects.volume.ColorBar instance +or dict with compatible properties
colorscale – Sets the colorscale. The colorscale must be an array +containing arrays mapping a normalized value to an rgb, +rgba, hex, hsl, hsv, or named color string. At minimum, +a mapping for the lowest (0) and highest (1) values are +required. For example, [[0, 'rgb(0,0,255)'], [1, +'rgb(255,0,0)']]. To control the bounds of the +colorscale in color space, use`cmin` and cmax. +Alternatively, colorscale may be a palette name +string of the following list: Greys,YlGnBu,Greens,YlOrR +d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H +ot,Blackbody,Earth,Electric,Viridis,Cividis.
contour – plotly.graph_objects.volume.Contour instance +or dict with compatible properties
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
flatshading – Determines whether or not normal smoothing is applied +to the meshes, creating meshes with an angular, low- +poly look via flat reflections.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.volume.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Same as text.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
lighting – plotly.graph_objects.volume.Lighting instance +or dict with compatible properties
lightposition – plotly.graph_objects.volume.Lightposition +instance or dict with compatible properties
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
opacity – Sets the opacity of the surface. Please note that in +the case of using high opacity values for example a +value greater than or equal to 0.5 on two surfaces (and +0.25 with four surfaces), an overlay of multiple +transparent surfaces may not perfectly be sorted in +depth by the webgl API. This behavior may be improved +in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an +array containing arrays mapping a normalized value to +an opacity value. At minimum, a mapping for the lowest +(0) and highest (1) values are required. For example, +[[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower +values would have higher opacity values and those in +the middle would be more transparent Alternatively, +opacityscale may be a palette name string of the +following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’. +The default is ‘uniform’.
reversescale – Reverses the color mapping if true. If true, cmin +will correspond to the last color in the array and +cmax will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate +system and a 3D scene. If “scene” (the default value), +the (x,y,z) coordinates refer to layout.scene. If +“scene2”, the (x,y,z) coordinates refer to +layout.scene2, and so on.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for +this trace.
slices – plotly.graph_objects.volume.Slices instance or +dict with compatible properties
spaceframe – plotly.graph_objects.volume.Spaceframe +instance or dict with compatible properties
stream – plotly.graph_objects.volume.Stream instance or +dict with compatible properties
surface – plotly.graph_objects.volume.Surface instance +or dict with compatible properties
text – Sets the text elements associated with the vertices. If +trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for +text .
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
value – Sets the 4th dimension (value) of the vertices.
valuesrc – Sets the source reference on Chart Studio Cloud for +value .
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
x – Sets the X coordinates of the vertices on X axis.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the Y coordinates of the vertices on Y axis.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
z – Sets the Z coordinates of the vertices on Z axis.
zsrc – Sets the source reference on Chart Studio Cloud for z +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots

Returns

Return type

FigureWidget

+ +

Add a new Waterfall trace

Parameters

alignmentgroup – Set several traces linked to the same position axis or +matching axes to the same alignmentgroup. This controls +whether bars compute their positional range dependently +or independently.
base – Sets where the bar base is drawn (in position axis +units).
cliponaxis – Determines whether the text nodes are clipped about the +subplot axes. To show the text nodes above axis lines +and tick labels, make sure to set xaxis.layer and +yaxis.layer to below traces.
connector – plotly.graph_objects.waterfall.Connector +instance or dict with compatible properties
constraintext – Constrain the size of text inside or outside a bar to +be no larger than the bar itself.
customdata – Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note +that, “scatter” traces also appends customdata items in +the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for +customdata .
decreasing – plotly.graph_objects.waterfall.Decreasing +instance or dict with compatible properties
dx – Sets the x coordinate step. See x0 for more info.
dy – Sets the y coordinate step. See y0 for more info.
hoverinfo – Determines which trace information appear on hover. If +none or skip are set, no information is displayed +upon hovering. But, if none is set, click and hover +events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for +hoverinfo .
hoverlabel – plotly.graph_objects.waterfall.Hoverlabel +instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that +appear on hover box. Note that this will override +hoverinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. The variables +available in hovertemplate are the ones emitted as +event data described at this link +https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be +specified per-point (the ones that are arrayOk: true) +are available. variables initial, delta and +final. Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary +box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for +hovertemplate .
hovertext – Sets hover text elements associated with each (x,y) +pair. If a single string, the same string appears over +all the data points. If an array of string, the items +are mapped in order to the this trace’s (x,y) +coordinates. To be seen, trace hoverinfo must contain +a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for +hovertext .
ids – Assigns id labels to each datum. These ids for object +constancy of data points during animation. Should be an +array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for +ids .
increasing – plotly.graph_objects.waterfall.Increasing +instance or dict with compatible properties
insidetextanchor – Determines if texts are kept at center or start/end +points in textposition “inside” mode.
insidetextfont – Sets the font used for text lying inside the bar.
legendgroup – Sets the legend group for this trace. Traces part of +the same legend group hide/show at the same time when +toggling legend items.
measure – An array containing types of values. By default the +values are considered as ‘relative’. However; it is +possible to use ‘total’ to compute the sums. Also +‘absolute’ could be applied to reset the computed total +or to declare an initial value where needed.
measuresrc – Sets the source reference on Chart Studio Cloud for +measure .
meta – Assigns extra meta information associated with this +trace that can be used in various text attributes. +Attributes such as trace name, graph, axis and +colorbar title.text, annotation text +rangeselector, updatemenues and sliders label +text all support meta. To access the trace meta +values in an attribute in the same trace, simply use +%{meta[i]} where i is the index or key of the +meta item in question. To access trace meta in +layout attributes, use %{data[n[.meta[i]} where i +is the index or key of the meta and n is the trace +index.
metasrc – Sets the source reference on Chart Studio Cloud for +meta .
name – Sets the trace name. The trace name appear as the +legend item and on hover.
offset – Shifts the position where the bar is drawn (in position +axis units). In “group” barmode, traces that set +“offset” will be excluded and drawn in “overlay” mode +instead.
offsetgroup – Set several traces linked to the same position axis or +matching axes to the same offsetgroup where bars of the +same position coordinate will line up.
offsetsrc – Sets the source reference on Chart Studio Cloud for +offset .
opacity – Sets the opacity of the trace.
orientation – Sets the orientation of the bars. With “v” (“h”), the +value of the each bar spans along the vertical +(horizontal).
outsidetextfont – Sets the font used for text lying outside the bar.
selectedpoints – Array containing integer indices of selected points. +Has an effect only for traces that support selections. +Note that an empty array means an empty selection where +the unselected are turned on for all points, whereas, +any other non-array values means no selection all where +the selected and unselected styles have no effect.
showlegend – Determines whether or not an item corresponding to this +trace is shown in the legend.
stream – plotly.graph_objects.waterfall.Stream instance +or dict with compatible properties
text – Sets text elements associated with each (x,y) pair. If +a single string, the same string appears over all the +data points. If an array of string, the items are +mapped in order to the this trace’s (x,y) coordinates. +If trace hoverinfo contains a “text” flag and +“hovertext” is not set, these elements will be seen in +the hover labels.
textangle – Sets the angle of the tick labels with respect to the +bar. For example, a tickangle of -90 draws the tick +labels vertically. With “auto” the texts may +automatically be rotated to fit with the maximum size +in bars.
textfont – Sets the font used for text.
textinfo – Determines which trace information appear on the graph. +In the case of having multiple waterfalls, totals are +computed separately (per trace).
textposition – Specifies the location of the text. “inside” +positions text inside, next to the bar end (rotated +and scaled if needed). “outside” positions text +outside, next to the bar end (scaled if needed), unless +there is another bar stacked on this one, then the text +gets pushed inside. “auto” tries to position text +inside the bar, but if the bar is too small and no bar +is stacked on this one the text is moved outside.
textpositionsrc – Sets the source reference on Chart Studio Cloud for +textposition .
textsrc – Sets the source reference on Chart Studio Cloud for +text .
texttemplate – Template string used for rendering the information text +that appear on points. Note that this will override +textinfo. Variables are inserted using %{variable}, +for example “y: %{y}”. Numbers are formatted using +d3-format’s syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for +details on the formatting syntax. Dates are formatted +using d3-time-format’s syntax %{variable|d3-time- +format}, for example “Day: %{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for +details on the date formatting syntax. Every attributes +that can be specified per-point (the ones that are +arrayOk: true) are available. variables initial, +delta, final and label.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for +texttemplate .
totals – plotly.graph_objects.waterfall.Totals instance +or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object +constancy between traces during animations and +transitions.
uirevision – Controls persistence of some user-driven changes to the +trace: constraintrange in parcoords traces, as well +as some editable: true modifications such as name +and colorbar.title. Defaults to layout.uirevision. +Note that other user-driven trace attribute changes are +controlled by layout attributes: trace.visible is +controlled by layout.legend.uirevision, +selectedpoints is controlled by +layout.selectionrevision, and colorbar.(x|y) +(accessible with config: {editable: true}) is +controlled by layout.editrevision. Trace changes are +tracked by uid, which only falls back on trace index +if no uid is provided. So if your app can add/remove +traces before the end of the data array, such that +the same trace has a different index, you can still +preserve user-driven changes if you give each trace a +uid that stays with it as it moves.
visible – Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as +a legend item (provided that the legend itself is +visible).
width – Sets the bar width (in position axis units).
widthsrc – Sets the source reference on Chart Studio Cloud for +width .
x – Sets the x coordinates.
x0 – Alternate to x. Builds a linear space of x +coordinates. Use with dx where x0 is the starting +coordinate and dx the step.
xaxis – Sets a reference between this trace’s x coordinates and +a 2D cartesian x axis. If “x” (the default value), the +x coordinates refer to layout.xaxis. If “x2”, the x +coordinates refer to layout.xaxis2, and so on.
xsrc – Sets the source reference on Chart Studio Cloud for x +.
y – Sets the y coordinates.
y0 – Alternate to y. Builds a linear space of y +coordinates. Use with dy where y0 is the starting +coordinate and dy the step.
yaxis – Sets a reference between this trace’s y coordinates and +a 2D cartesian y axis. If “y” (the default value), the +y coordinates refer to layout.yaxis. If “y2”, the y +coordinates refer to layout.yaxis2, and so on.
ysrc – Sets the source reference on Chart Studio Cloud for y +.
row (int or None (default)) – Subplot row index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
col (int or None (default)) – Subplot col index (starting from 1) for the trace to be +added. Only valid if figure was created using +plotly.tools.make_subplots
secondary_y (boolean or None (default None)) –
If True, associate this trace with the secondary y-axis of the +subplot at the specified row and col. Only valid if all of the +following conditions are satisfied:
+
+
- The figure was created using plotly.subplots.make_subplots.
- The row and col arguments are not None
- The subplot at the specified row and col has type xy +(which is the default) and secondary_y True. These +properties are specified in the specs argument to +make_subplots. See the make_subplots docstring for more info.
+
+

Returns

Return type

FigureWidget

+ +

+for_each_annotation(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all annotations that satisfy the specified selection +criteria

Parameters

fn – Function that inputs a single annotation object.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all annotations are +selected.
col (row,) – Subplot row and column index of annotations to select. +To select annotations by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +annotations that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
- If True, only select annotations associated with the secondary +y-axis of the subplot.
- If False, only select annotations associated with the primary +y-axis of the subplot.
- If None (the default), do not filter annotations based on secondary +y-axis.
+
To select annotations by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_coloraxis(fn, selector=None, row=None, col=None)¶

Apply a function to all coloraxis objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single coloraxis object.
selector (dict or None (default None)) – Dict to use as selection criteria. +coloraxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all coloraxis objects are selected.
col (row,) – Subplot row and column index of coloraxis objects to select. +To select coloraxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all coloraxis objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_geo(fn, selector=None, row=None, col=None)¶

Apply a function to all geo objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single geo object.
selector (dict or None (default None)) – Dict to use as selection criteria. +geo objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all geo objects are selected.
col (row,) – Subplot row and column index of geo objects to select. +To select geo objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all geo objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_layout_image(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all images that satisfy the specified selection +criteria

Parameters

fn – Function that inputs a single image object.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all images are +selected.
col (row,) – Subplot row and column index of images to select. +To select images by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +images that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
- If True, only select images associated with the secondary +y-axis of the subplot.
- If False, only select images associated with the primary +y-axis of the subplot.
- If None (the default), do not filter images based on secondary +y-axis.
+
To select images by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_mapbox(fn, selector=None, row=None, col=None)¶

Apply a function to all mapbox objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single mapbox object.
selector (dict or None (default None)) – Dict to use as selection criteria. +mapbox objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all mapbox objects are selected.
col (row,) – Subplot row and column index of mapbox objects to select. +To select mapbox objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all mapbox objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_polar(fn, selector=None, row=None, col=None)¶

Apply a function to all polar objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single polar object.
selector (dict or None (default None)) – Dict to use as selection criteria. +polar objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all polar objects are selected.
col (row,) – Subplot row and column index of polar objects to select. +To select polar objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all polar objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_scene(fn, selector=None, row=None, col=None)¶

Apply a function to all scene objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single scene object.
selector (dict or None (default None)) – Dict to use as selection criteria. +scene objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all scene objects are selected.
col (row,) – Subplot row and column index of scene objects to select. +To select scene objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all scene objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_shape(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all shapes that satisfy the specified selection +criteria

Parameters

fn – Function that inputs a single shape object.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all shapes are +selected.
col (row,) – Subplot row and column index of shapes to select. +To select shapes by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +shapes that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
- If True, only select shapes associated with the secondary +y-axis of the subplot.
- If False, only select shapes associated with the primary +y-axis of the subplot.
- If None (the default), do not filter shapes based on secondary +y-axis.
+
To select shapes by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_ternary(fn, selector=None, row=None, col=None)¶

Apply a function to all ternary objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single ternary object.
selector (dict or None (default None)) – Dict to use as selection criteria. +ternary objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all ternary objects are selected.
col (row,) – Subplot row and column index of ternary objects to select. +To select ternary objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all ternary objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_xaxis(fn, selector=None, row=None, col=None)¶

Apply a function to all xaxis objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single xaxis object.
selector (dict or None (default None)) – Dict to use as selection criteria. +xaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all xaxis objects are selected.
col (row,) – Subplot row and column index of xaxis objects to select. +To select xaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all xaxis objects are selected.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+for_each_yaxis(fn, selector=None, row=None, col=None, secondary_y=None)¶

Apply a function to all yaxis objects that satisfy the +specified selection criteria

Parameters

fn – Function that inputs a single yaxis object.
selector (dict or None (default None)) – Dict to use as selection criteria. +yaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all yaxis objects are selected.
col (row,) – Subplot row and column index of yaxis objects to select. +To select yaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
- If True, only select yaxis objects associated with the secondary +y-axis of the subplot.
- If False, only select yaxis objects associated with the primary +y-axis of the subplot.
- If None (the default), do not filter yaxis objects based on +a secondary y-axis condition.
+
To select yaxis objects by secondary y-axis, the Figure must +have been created using plotly.subplots.make_subplots. See +the docstring for the specs argument to make_subplots for more +info on creating subplots with secondary y-axes.
+

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+select_annotations(selector=None, row=None, col=None, secondary_y=None)¶

Select annotations from a particular subplot cell and/or annotations +that satisfy custom selection criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +Annotations will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all annotations are +selected.
col (row,) – Subplot row and column index of annotations to select. +To select annotations by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +annotation that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
- If True, only select annotations associated with the secondary +y-axis of the subplot.
- If False, only select annotations associated with the primary +y-axis of the subplot.
- If None (the default), do not filter annotations based on secondary +y-axis.
+
To select annotations by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the annotations that satisfy +all of the specified selection criteria

Return type

generator

+ +

+select_coloraxes(selector=None, row=None, col=None)¶

Select coloraxis subplot objects from a particular subplot cell +and/or coloraxis subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +coloraxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all coloraxis objects are selected.
col (row,) – Subplot row and column index of coloraxis objects to select. +To select coloraxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all coloraxis objects are selected.

Returns

Generator that iterates through all of the coloraxis +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_geos(selector=None, row=None, col=None)¶

Select geo subplot objects from a particular subplot cell +and/or geo subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +geo objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all geo objects are selected.
col (row,) – Subplot row and column index of geo objects to select. +To select geo objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all geo objects are selected.

Returns

Generator that iterates through all of the geo +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_layout_images(selector=None, row=None, col=None, secondary_y=None)¶

Select images from a particular subplot cell and/or images +that satisfy custom selection criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +Annotations will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all images are +selected.
col (row,) – Subplot row and column index of images to select. +To select images by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +image that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
- If True, only select images associated with the secondary +y-axis of the subplot.
- If False, only select images associated with the primary +y-axis of the subplot.
- If None (the default), do not filter images based on secondary +y-axis.
+
To select images by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the images that satisfy +all of the specified selection criteria

Return type

generator

+ +

+select_mapboxes(selector=None, row=None, col=None)¶

Select mapbox subplot objects from a particular subplot cell +and/or mapbox subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +mapbox objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all mapbox objects are selected.
col (row,) – Subplot row and column index of mapbox objects to select. +To select mapbox objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all mapbox objects are selected.

Returns

Generator that iterates through all of the mapbox +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_polars(selector=None, row=None, col=None)¶

Select polar subplot objects from a particular subplot cell +and/or polar subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +polar objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all polar objects are selected.
col (row,) – Subplot row and column index of polar objects to select. +To select polar objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all polar objects are selected.

Returns

Generator that iterates through all of the polar +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_scenes(selector=None, row=None, col=None)¶

Select scene subplot objects from a particular subplot cell +and/or scene subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +scene objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all scene objects are selected.
col (row,) – Subplot row and column index of scene objects to select. +To select scene objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all scene objects are selected.

Returns

Generator that iterates through all of the scene +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_shapes(selector=None, row=None, col=None, secondary_y=None)¶

Select shapes from a particular subplot cell and/or shapes +that satisfy custom selection criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +Annotations will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all shapes are +selected.
col (row,) – Subplot row and column index of shapes to select. +To select shapes by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +shape that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
- If True, only select shapes associated with the secondary +y-axis of the subplot.
- If False, only select shapes associated with the primary +y-axis of the subplot.
- If None (the default), do not filter shapes based on secondary +y-axis.
+
To select shapes by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the shapes that satisfy +all of the specified selection criteria

Return type

generator

+ +

+select_ternaries(selector=None, row=None, col=None)¶

Select ternary subplot objects from a particular subplot cell +and/or ternary subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +ternary objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all ternary objects are selected.
col (row,) – Subplot row and column index of ternary objects to select. +To select ternary objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all ternary objects are selected.

Returns

Generator that iterates through all of the ternary +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_xaxes(selector=None, row=None, col=None)¶

Select xaxis subplot objects from a particular subplot cell +and/or xaxis subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +xaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all xaxis objects are selected.
col (row,) – Subplot row and column index of xaxis objects to select. +To select xaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all xaxis objects are selected.

Returns

Generator that iterates through all of the xaxis +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+select_yaxes(selector=None, row=None, col=None, secondary_y=None)¶

Select yaxis subplot objects from a particular subplot cell +and/or yaxis subplot objects that satisfy custom selection +criteria.

Parameters

selector (dict or None (default None)) – Dict to use as selection criteria. +yaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all yaxis objects are selected.
col (row,) – Subplot row and column index of yaxis objects to select. +To select yaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
- If True, only select yaxis objects associated with the secondary +y-axis of the subplot.
- If False, only select yaxis objects associated with the primary +y-axis of the subplot.
- If None (the default), do not filter yaxis objects based on +a secondary y-axis condition.
+
To select yaxis objects by secondary y-axis, the Figure must +have been created using plotly.subplots.make_subplots. See +the docstring for the specs argument to make_subplots for more +info on creating subplots with secondary y-axes.
+

Returns

Generator that iterates through all of the yaxis +objects that satisfy all of the specified selection criteria

Return type

generator

+ +

+update_annotations(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all annotations that satisfy the +specified selection criteria

Parameters

patch (dict or None (default None)) – Dictionary of property updates to be applied to all annotations that +satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all annotations are +selected.
col (row,) – Subplot row and column index of annotations to select. +To select annotations by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +annotation that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all annotations are selected.
secondary_y (boolean or None (default None)) –
- If True, only select annotations associated with the secondary +y-axis of the subplot.
- If False, only select annotations associated with the primary +y-axis of the subplot.
- If None (the default), do not filter annotations based on secondary +y-axis.
+
To select annotations by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected annotation. If +a property is specified in both patch and in **kwargs then the +one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_coloraxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all coloraxis objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +coloraxis objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +coloraxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all coloraxis objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of coloraxis objects to select. +To select coloraxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all coloraxis objects are selected.
**kwargs – Additional property updates to apply to each selected +coloraxis object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_geos(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all geo objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +geo objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +geo objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all geo objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of geo objects to select. +To select geo objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all geo objects are selected.
**kwargs – Additional property updates to apply to each selected +geo object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_layout_images(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all images that satisfy the +specified selection criteria

Parameters

patch (dict or None (default None)) – Dictionary of property updates to be applied to all images that +satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all images are +selected.
col (row,) – Subplot row and column index of images to select. +To select images by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +image that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all images are selected.
secondary_y (boolean or None (default None)) –
- If True, only select images associated with the secondary +y-axis of the subplot.
- If False, only select images associated with the primary +y-axis of the subplot.
- If None (the default), do not filter images based on secondary +y-axis.
+
To select images by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected image. If +a property is specified in both patch and in **kwargs then the +one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_mapboxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all mapbox objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +mapbox objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +mapbox objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all mapbox objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of mapbox objects to select. +To select mapbox objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all mapbox objects are selected.
**kwargs – Additional property updates to apply to each selected +mapbox object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_polars(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all polar objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +polar objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +polar objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all polar objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of polar objects to select. +To select polar objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all polar objects are selected.
**kwargs – Additional property updates to apply to each selected +polar object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_scenes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all scene objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +scene objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +scene objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all scene objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of scene objects to select. +To select scene objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all scene objects are selected.
**kwargs – Additional property updates to apply to each selected +scene object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_shapes(patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all shapes that satisfy the +specified selection criteria

Parameters

patch (dict or None (default None)) – Dictionary of property updates to be applied to all shapes that +satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +Traces will be selected if they contain properties corresponding +to all of the dictionary’s keys, with values that exactly match +the supplied values. If None (the default), all shapes are +selected.
col (row,) – Subplot row and column index of shapes to select. +To select shapes by row and column, the Figure must have been +created using plotly.subplots.make_subplots. To select only those +shape that are in paper coordinates, set row and col to the +string ‘paper’. If None (the default), all shapes are selected.
secondary_y (boolean or None (default None)) –
- If True, only select shapes associated with the secondary +y-axis of the subplot.
- If False, only select shapes associated with the primary +y-axis of the subplot.
- If None (the default), do not filter shapes based on secondary +y-axis.
+
To select shapes by secondary y-axis, the Figure must have been +created using plotly.subplots.make_subplots. See the docstring +for the specs argument to make_subplots for more info on +creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected shape. If +a property is specified in both patch and in **kwargs then the +one in **kwargs takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_ternaries(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all ternary objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +ternary objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +ternary objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all ternary objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of ternary objects to select. +To select ternary objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all ternary objects are selected.
**kwargs – Additional property updates to apply to each selected +ternary object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_xaxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶

Perform a property update operation on all xaxis objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +xaxis objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +xaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all xaxis objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of xaxis objects to select. +To select xaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all xaxis objects are selected.
**kwargs – Additional property updates to apply to each selected +xaxis object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+update_yaxes(patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs)¶

Perform a property update operation on all yaxis objects +that satisfy the specified selection criteria

Parameters

patch (dict) – Dictionary of property updates to be applied to all +yaxis objects that satisfy the selection criteria.
selector (dict or None (default None)) – Dict to use as selection criteria. +yaxis objects will be selected if they contain +properties corresponding to all of the dictionary’s keys, with +values that exactly match the supplied values. If None +(the default), all yaxis objects are selected.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates +to existing properties recursively, preserving existing +properties that are not specified in the update operation.
col (row,) – Subplot row and column index of yaxis objects to select. +To select yaxis objects by row and column, the Figure +must have been created using plotly.subplots.make_subplots. +If None (the default), all yaxis objects are selected.
secondary_y (boolean or None (default None)) –
- If True, only select yaxis objects associated with the secondary +y-axis of the subplot.
- If False, only select yaxis objects associated with the primary +y-axis of the subplot.
- If None (the default), do not filter yaxis objects based on +a secondary y-axis condition.
+
To select yaxis objects by secondary y-axis, the Figure must +have been created using plotly.subplots.make_subplots. See +the docstring for the specs argument to make_subplots for more +info on creating subplots with secondary y-axes.
+
**kwargs – Additional property updates to apply to each selected +yaxis object. If a property is specified in +both patch and in **kwargs then the one in **kwargs +takes precedence.

Returns

Returns the Figure object that the method was called on

Return type

self

+ +

+ + +

+ +

plotly.graph_objects.layout.template.data package¶

Module contents¶

+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, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property base¶

Sets where the bar base is drawn (in position axis units).

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
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.waterfall.connecto +r.Line instance or dict with compatible +properties
+
+
mode
Sets the shape of connector lines.
+
+
visible
Determines if connector lines are drawn.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.waterfall.decreasi +ng.Marker instance or dict with compatible +properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.waterfall.Hoverlabel
+

+ +

+property hovertemplate¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.waterfall.increasi +ng.Marker instance or dict with compatible +properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.waterfall.Insidetextfont
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property measure¶

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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

Shifts the position where the bar is drawn (in position axis +units). In “group” barmode, traces that set “offset” will be +excluded and drawn in “overlay” mode instead.

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property offsetgroup¶

Set several traces linked to the same position axis or matching +axes to the same offsetgroup where bars of the same position +coordinate will line up.

The ‘offsetgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offsetsrc¶

Sets the source reference on Chart Studio Cloud for offset .

The ‘offsetsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property orientation¶

Sets the orientation of the bars. With “v” (“h”), the value of +the each bar spans along the vertical (horizontal).

The ‘orientation’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘v’, ‘h’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property outsidetextfont¶

Sets the font used for text lying outside the bar.

The ‘outsidetextfont’ property is an instance of Outsidetextfont +that may be specified as:

+
+
An instance of plotly.graph_objects.waterfall.Outsidetextfont
+
A dict of string/value properties that will be passed +to the Outsidetextfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.waterfall.Outsidetextfont
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.waterfall.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.waterfall.Stream
+

+ +

+property text¶

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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.waterfall.totals.M +arker instance or dict with compatible +properties
+
+
+
+
+
+

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¶

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¶

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 y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property 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.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, legendgroup=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, valuesrc=None, visible=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.volume.caps.X +instance or dict with compatible properties
+
+
y
plotly.graph_objects.volume.caps.Y +instance or dict with compatible properties
+
+
z
plotly.graph_objects.volume.caps.Z +instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.volume.Caps
+

+ +

+property cauto¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.volume. +colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.volume.colorbar.tickformatstopdefaults), sets +the default property values to use for elements +of volume.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.volume.colorbar.Ti +tle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +volume.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +volume.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.volume.ColorBar
+

+ +

+property colorscale¶

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the color of the contour lines.
+
+
show
Sets whether or not dynamic contours are shown +on hover
+
+
width
Sets the width of the contour lines.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

The ‘lighting’ property is an instance of Lighting +that may be specified as:

+
+
An instance of plotly.graph_objects.volume.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.volume.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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¶

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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.volume.slices.X +instance or dict with compatible properties
+
+
y
plotly.graph_objects.volume.slices.Y +instance or dict with compatible properties
+
+
z
plotly.graph_objects.volume.slices.Z +instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
fill
Sets the fill ratio of the spaceframe +elements. The default fill value is 1 meaning +that they are entirely shaded. Applying a +fill ratio less than one would allow the +creation of openings parallel to the edges.
+
+
show
Displays/hides tetrahedron shapes between +minimum and maximum iso-values. Often useful +when either caps or surfaces are disabled or +filled with values less than 1.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
count
Sets the number of iso-surfaces between minimum +and maximum iso-values. By default this value +is 2 meaning that only minimum and maximum +surfaces would be drawn.
+
+
fill
Sets the fill ratio of the iso-surface. The +default fill value of the surface is 1 meaning +that they are entirely shaded. On the other +hand Applying a fill ratio less than one +would allow the creation of openings parallel +to the edges.
+
+
pattern
Sets the surface pattern of the iso-surface 3-D +sections. The default pattern of the surface is +all meaning that the rest of surface elements +would be shaded. The check options (either 1 or +2) could be used to draw half of the squares on +the surface. Using various combinations of +capital A, B, C, D and E may also be +used to reduce the number of triangles on the +iso-surfaces and creating other patterns of +interest.
+
+
show
Hides/displays surfaces between minimum and +maximum iso-values.
+
+
+
+
+
+

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¶

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 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 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 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 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.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, legendgroup=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
fillcolor
Sets the inner box plot fill color.
+
+
line
plotly.graph_objects.violin.box.Line +instance or dict with compatible properties
+
+
visible
Determines if an miniature box plot is drawn +inside the violins.
+
+
width
Sets the width of the inner box plots relative +to the violins’ width. For example, with 1, the +inner box plots are as wide as the violins.
+
+
+
+
+
+

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.violin.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘jitter’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.violin.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of line bounding the violin(s).
+
+
width
Sets the width (in px) of line bounding the +violin(s).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
line
:class:`plotly.graph_objects.violin.marker.Line +` instance or dict with compatible properties
+
+
opacity
Sets the marker opacity.
+
+
outliercolor
Sets the color of the outlier sample points.
+
+
size
Sets the marker size (in px).
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
color
Sets the mean line color.
+
+
visible
Determines if a line corresponding to the +sample’s mean is shown inside the violins. If +box.visible is turned on, the mean line is +drawn inside the inner box. Otherwise, the mean +line is drawn from one side of the violin to +other.
+
+
width
Sets the mean line width.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.violin.Meanline
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

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¶

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¶

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 scalegroup¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.violin.selected.Ma +rker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.violin.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property side¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.violin.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.violin.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.violin.unselected. +Marker instance or dict with compatible +properties
+
+
+
+
+
+

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¶

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¶

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=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¶

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this treemap trace +.
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this treemap trace .
+
+
x
Sets the horizontal domain of this treemap +trace (in plot fraction).
+
+
y
Sets the vertical domain of this treemap trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 level¶

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if colorsis set to a numerical +array. In case colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +colors) or the bounds set in marker.cmin and +marker.cmax Has an effect only if colorsis +set to a numerical array. Defaults to false +when marker.cmin and marker.cmax are set by +the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmin must be set as +well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if colorsis set to a numerical array. +Value should have the same units as colors. Has +no effect when marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmax must be set as +well.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.treemap.marker.Col +orBar instance or dict with compatible +properties
+
+
colors
Sets the color of each sector of this trace. If +not specified, the default trace color set is +used to pick the sector colors.
+
+
colorscale
Sets the colorscale. Has an effect only if +colorsis set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
depthfade
Determines if the sector colors are faded +towards the background from the leaves up to +the headers. This option is unavailable when a +colorscale is present, defaults to false when +marker.colors is set, but otherwise defaults +to true. When set to “reversed”, the fading +direction is inverted, that is the top elements +within hierarchy are drawn with fully saturated +colors while the leaves are faded towards the +background color.
+
+
line
plotly.graph_objects.treemap.marker.Lin +e instance or dict with compatible properties
+
+
pad
:class:`plotly.graph_objects.treemap.marker.Pad +` instance or dict with compatible properties
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if colorsis set to a numerical +array. If true, marker.cmin will correspond +to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +colorsis set to a numerical array.
+
+
+
+
+
+

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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property outsidetextfont¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.treemap.Outsidetextfont
+

+ +

+property parents¶

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
+
Supported dict properties:
+
+
+
edgeshape
Determines which shape is used for edges +between barpath labels.
+
+
side
Determines on which side of the the treemap the +pathbar should be presented.
+
+
textfont
Sets the font used inside pathbar.
+
+
thickness
Sets the thickness of pathbar (in px). If not +specified the pathbar.textfont.size is used +with 3 pixles extra padding on each side.
+
+
visible
Determines if the path bar is drawn i.e. +outside the trace domain and with one pixel +gap.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.treemap.Pathbar
+

+ +

+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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.treemap.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
flip
Determines if the positions obtained from +solver are flipped on each axis.
+
+
packing
Determines d3 treemap solver. For more info +please refer to +https://github.com/d3/d3-hierarchy#treemap- +tiling
+
+
pad
Sets the inner padding (in px).
+
+
squarifyratio
When using “squarify” packing algorithm, +according to https://github.com/d3/d3-hierarchy +/blob/master/README.md#squarify_ratio this +option specifies the desired aspect ratio of +the generated rectangles. The ratio must be +specified as a number greater than or equal to +one. Note that the orientation of the generated +rectangles (tall or wide) is not implied by the +ratio; for example, a ratio of two will attempt +to produce a mixture of rectangles whose +width:height ratio is either 2:1 or 1:2. When +using “squarify”, unlike d3 which uses the +Golden Ratio i.e. 1.618034, Plotly applies 1 to +increase squares in treemap layouts.
+
+
+
+
+
+

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¶

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.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, 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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +within the box. Has an effect only if text +spans two or more lines (i.e. text contains +one or more HTML tags) or if an explicit +width is set to override the text width.
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
fill
plotly.graph_objects.table.cells.Fill +instance or dict with compatible properties
+
+
font
plotly.graph_objects.table.cells.Font +instance or dict with compatible properties
+
+
format
Sets the cell value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
formatsrc
Sets the source reference on Chart Studio Cloud +for format .
+
+
height
The height of cells.
+
+
line
plotly.graph_objects.table.cells.Line +instance or dict with compatible properties
+
+
prefix
Prefix for cell values.
+
+
prefixsrc
Sets the source reference on Chart Studio Cloud +for prefix .
+
+
suffix
Suffix for cell values.
+
+
suffixsrc
Sets the source reference on Chart Studio Cloud +for suffix .
+
+
values
Cell values. values[m][n] represents the +value of the n`th point in column `m, +therefore the values[m] vector length for all +columns must be the same (longer vectors will +be truncated). Each value must be a finite +number or a string.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.table.Cells
+

+ +

+property columnorder¶

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this table trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this table trace .
+
+
x
Sets the horizontal domain of this table trace +(in plot fraction).
+
+
y
Sets the vertical domain of this table trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +within the box. Has an effect only if text +spans two or more lines (i.e. text contains +one or more HTML tags) or if an explicit +width is set to override the text width.
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
fill
plotly.graph_objects.table.header.Fill +instance or dict with compatible properties
+
+
font
plotly.graph_objects.table.header.Font +instance or dict with compatible properties
+
+
format
Sets the cell value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
formatsrc
Sets the source reference on Chart Studio Cloud +for format .
+
+
height
The height of cells.
+
+
line
plotly.graph_objects.table.header.Line +instance or dict with compatible properties
+
+
prefix
Prefix for cell values.
+
+
prefixsrc
Sets the source reference on Chart Studio Cloud +for prefix .
+
+
suffix
Suffix for cell values.
+
+
suffixsrc
Sets the source reference on Chart Studio Cloud +for suffix .
+
+
values
Header cell values. values[m][n] represents +the value of the n`th point in column `m, +therefore the values[m] vector length for all +columns must be the same (longer vectors will +be truncated). Each value must be a finite +number or a string.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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.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, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property cauto¶

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¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.surface +.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.surface.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of surface.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.surface.colorbar.T +itle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +surface.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +surface.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.surface.ColorBar
+

+ +

+property colorscale¶

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property connectgaps¶

Determines whether or not gaps (i.e. {nan} or missing values) +in the z data are filled in.

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
+
Supported dict properties:
+
+
+
x
:class:`plotly.graph_objects.surface.contours.X +` instance or dict with compatible properties
+
+
y
:class:`plotly.graph_objects.surface.contours.Y +` instance or dict with compatible properties
+
+
z
:class:`plotly.graph_objects.surface.contours.Z +` instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.surface.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

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.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, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=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¶

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this sunburst trace +.
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this sunburst trace .
+
+
x
Sets the horizontal domain of this sunburst +trace (in plot fraction).
+
+
y
Sets the vertical domain of this sunburst trace +(in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sunburst.Insidetextfont
+

+ +

+property insidetextorientation¶

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
+
Supported dict properties:
+
+
+
opacity
Sets the opacity of the leaves. With colorscale +it is defaulted to 1; otherwise it is defaulted +to 0.7
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sunburst.Leaf
+

+ +

+property level¶

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if colorsis set to a numerical +array. In case colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +colors) or the bounds set in marker.cmin and +marker.cmax Has an effect only if colorsis +set to a numerical array. Defaults to false +when marker.cmin and marker.cmax are set by +the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmin must be set as +well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if colorsis set to a numerical array. +Value should have the same units as colors. Has +no effect when marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if colorsis set to a numerical +array. Value should have the same units as +colors and if set, marker.cmax must be set as +well.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.sunburst.marker.Co +lorBar instance or dict with compatible +properties
+
+
colors
Sets the color of each sector of this trace. If +not specified, the default trace color set is +used to pick the sector colors.
+
+
colorscale
Sets the colorscale. Has an effect only if +colorsis set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
line
plotly.graph_objects.sunburst.marker.Li +ne instance or dict with compatible properties
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if colorsis set to a numerical +array. If true, marker.cmin will correspond +to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +colorsis set to a numerical array.
+
+
+
+
+
+

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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property outsidetextfont¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sunburst.Outsidetextfont
+

+ +

+property parents¶

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 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sunburst.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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.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, legendgroup=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, uid=None, uirevision=None, usrc=None, v=None, visible=None, vsrc=None, w=None, wsrc=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property cauto¶

The ‘cauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property cmax¶

Sets the upper bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmin must be set as +well.

The ‘cmax’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmid¶

Sets the mid-point of the color domain by scaling cmin and/or +cmax to be equidistant to this point. Value should have the +same units as u/v/w norm. Has no effect when cauto is +false.

The ‘cmid’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmin¶

Sets the lower bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmax must be set as +well.

The ‘cmin’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.streamtube.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.streamt +ube.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.streamtube.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of streamtube.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.streamtube.colorba +r.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +streamtube.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +streamtube.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.streamtube.ColorBar
+

+ +

+property colorscale¶

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

The ‘lighting’ property is an instance of Lighting +that may be specified as:

+
+
An instance of plotly.graph_objects.streamtube.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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
+
Supported dict properties:
+
+
+
x
Sets the x components of the starting position +of the streamtubes
+
+
xsrc
Sets the source reference on Chart Studio Cloud +for x .
+
+
y
Sets the y components of the starting position +of the streamtubes
+
+
ysrc
Sets the source reference on Chart Studio Cloud +for y .
+
+
z
Sets the z components of the starting position +of the streamtubes
+
+
zsrc
Sets the source reference on Chart Studio Cloud +for z .
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.streamtube.Stream
+

+ +

+property text¶

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 uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property usrc¶

Sets the source reference on Chart Studio Cloud for u .

The ‘usrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property v¶

Sets the y components of the vector field.

The ‘v’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property vsrc¶

Sets the source reference on Chart Studio Cloud for v .

The ‘vsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property w¶

Sets the z components of the vector field.

The ‘w’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property wsrc¶

Sets the source reference on Chart Studio Cloud for w .

The ‘wsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property x¶

Sets the x coordinates of the vector field.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates of the vector field.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property z¶

Sets the z coordinates of the vector field.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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, yaxes=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
+
Supported dict properties:
+
+
+
visible
Determines whether or not subplots on the +diagonal are displayed.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
axis
plotly.graph_objects.splom.dimension.Ax +is instance or dict with compatible properties
+
+
label
Sets the label corresponding to this splom +dimension.
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
values
Sets the dimension values to be plotted.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
visible
Determines whether or not this dimension is +shown on the graph. Note that even visible +false dimension contribute to the default grid +generate by this splom trace.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.splom.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.splom.marker.Color +Bar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.splom.marker.Line +instance or dict with compatible properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.splom.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.splom.selected.Mar +ker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.splom.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.splom.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.splom.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.splom.unselected.M +arker instance or dict with compatible +properties
+
+
+
+
+
+

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¶

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 yaxes¶

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
+

+ +

+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, legendgroup=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¶

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¶

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¶

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¶

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¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterternary.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatterternary.mar +ker.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scatterternary.mar +ker.Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scatterternary.mar +ker.Line instance or dict with compatible +properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterternary.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterternary.sel +ected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterternary.sel +ected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterternary.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scatterternary.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterternary.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterternary.uns +elected.Marker instance or dict with +compatible properties
+
+
textfont
plotly.graph_objects.scatterternary.uns +elected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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.Scatter(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, orientation=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, t=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property cliponaxis¶

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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.ErrorY
+

+ +

+property fill¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property groupnorm¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
simplify
Simplifies lines by removing nearly-collinear +points. When transitioning lines, it may be +desirable to disable this so that the number of +points along the resulting SVG path is +unaffected.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatter.marker.Col +orBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scatter.marker.Gra +dient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scatter.marker.Lin +e instance or dict with compatible properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property orientation¶

The ‘orientation’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘v’, ‘h’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property r¶

r coordinates in scatter traces are deprecated!Please switch to +the “scatterpolar” trace type.Sets the radial coordinatesfor +legacy polar chart only.

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.scatter.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatter.selected.M +arker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatter.selected.T +extfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stackgaps¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter.Stream
+

+ +

+property t¶

t coordinates in scatter traces are deprecated!Please switch to +the “scatterpolar” trace type.Sets the angular coordinatesfor +legacy polar chart only.

The ‘t’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘texttemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for +texttemplate .

The ‘texttemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.scatter.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatter.unselected +.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatter.unselected +.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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¶

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¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatterpolar.marke +r.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scatterpolar.marke +r.Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scatterpolar.marke +r.Line instance or dict with compatible +properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property r¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolar.selec +ted.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterpolar.selec +ted.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scatterpolar.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolar.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolar.unsel +ected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterpolar.unsel +ected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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, legendgroup=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¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the style of the lines.
+
+
shape
Determines the line shape. The values +correspond to step-wise line shapes.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatterpolargl.mar +ker.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.scatterpolargl.mar +ker.Line instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolargl.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property r¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolargl.sel +ected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scatterpolargl.sel +ected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolargl.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scatterpolargl.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatterpolargl.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scatterpolargl.uns +elected.Marker instance or dict with +compatible properties
+
+
textfont
plotly.graph_objects.scatterpolargl.uns +elected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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.Scattermapbox(arg=None, below=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, legendgroup=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¶

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 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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property lat¶

Sets the latitude coordinates (in degrees North).

The ‘lat’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property latsrc¶

Sets the source reference on Chart Studio Cloud for lat .

The ‘latsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattermapbox.mark +er.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol. Full list: +https://www.mapbox.com/maki-icons/ Note that +the array marker.color and marker.size are +only available for “circle” symbols.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattermapbox.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattermapbox.sele +cted.Marker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattermapbox.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scattermapbox.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattermapbox.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattermapbox.unse +lected.Marker instance or dict with compatible +properties
+
+
+
+
+
+

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.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, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.ErrorY
+

+ +

+property fill¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.scattergl.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the style of the lines.
+
+
shape
Determines the line shape. The values +correspond to step-wise line shapes.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattergl.marker.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.scattergl.marker.L +ine instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergl.selected +.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergl.selected +.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scattergl.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergl.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergl.unselect +ed.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergl.unselect +ed.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property geo¶

Returns: +
Return type: str
+

+ +

+property geojson¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property lat¶

Sets the latitude coordinates (in degrees North).

The ‘lat’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property latsrc¶

Sets the source reference on Chart Studio Cloud for lat .

The ‘latsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Line
+

+ +

+property locationmode¶

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattergeo.marker. +ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scattergeo.marker. +Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scattergeo.marker. +Line instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergeo.selecte +d.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergeo.selecte +d.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scattergeo.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattergeo.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattergeo.unselec +ted.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattergeo.unselec +ted.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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.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, legendgroup=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, **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¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Hoverlabel
+

+ +

+property hoveron¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the line color.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
shape
Determines the line shape. With “spline” the +lines are drawn using spline interpolation. The +other available values correspond to step-wise +line shapes.
+
+
smoothing
Has an effect only if shape is set to +“spline” Sets the amount of smoothing. 0 +corresponds to no smoothing (equivalent to a +“linear” shape).
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scattercarpet.mark +er.ColorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
gradient
plotly.graph_objects.scattercarpet.mark +er.Gradient instance or dict with compatible +properties
+
+
line
plotly.graph_objects.scattercarpet.mark +er.Line instance or dict with compatible +properties
+
+
maxdisplayed
Sets a maximum number of points to be drawn on +the graph. 0 corresponds to no limit.
+
+
opacity
Sets the marker opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattercarpet.sele +cted.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattercarpet.sele +cted.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.scattercarpet.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scattercarpet.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.scattercarpet.unse +lected.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.scattercarpet.unse +lected.Textfont instance or dict with +compatible properties
+
+
+
+
+
+

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¶

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+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, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_zstyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_zstyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by line.colorscale. Has an effect +only if in line.color`is set to a numerical +array. In case `colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in line.color) or the bounds set in +line.cmin and line.cmax Has an effect only +if in line.color`is set to a numerical array. +Defaults to `false when line.cmin and +line.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling line.cmin and/or line.cmax to be +equidistant to this point. Has an effect only +if in line.color`is set to a numerical array. +Value should have the same units as in +`line.color. Has no effect when line.cauto +is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmax must be set as well.
+
+
color
Sets thelinecolor. It accepts either a specific +color or an array of numbers that are mapped to +the colorscale relative to the max and min +values of the array or relative to line.cmin +and line.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatter3d.line.Col +orBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +line.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`line.cmin` and line.cmax. +Alternatively, colorscale may be a palette +name string of the following list: Greys,YlGnBu +,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R +ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri +c,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
dash
Sets the dash style of the lines.
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in line.color`is set to a +numerical array. If true, `line.cmin will +correspond to the last color in the array and +line.cmax will correspond to the first color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `line.color`is set to a numerical array.
+
+
width
Sets the line width (in px).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.scatter3d.marker.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.scatter3d.marker.L +ine instance or dict with compatible +properties
+
+
opacity
Sets the marker opacity. Note that the marker +opacity for scatter3d traces must be a scalar +value for performance reasons. To set a +blending opacity value (i.e. which is not +transparent), set “marker.color” to an rgba +color and use its alpha channel.
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
size
Sets the marker size (in px).
+
+
sizemin
Has an effect only if marker.size is set to a +numerical array. Sets the minimum size (in px) +of the rendered marker points.
+
+
sizemode
Has an effect only if marker.size is set to a +numerical array. Sets the rule for which the +data in size is converted to pixels.
+
+
sizeref
Has an effect only if marker.size is set to a +numerical array. Sets the scale factor used to +determine the rendered size of marker points. +Use with sizemin and sizemode.
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Sets the marker symbol type.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter3d.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.scatter3d.projecti +on.X instance or dict with compatible +properties
+
+
y
plotly.graph_objects.scatter3d.projecti +on.Y instance or dict with compatible +properties
+
+
z
plotly.graph_objects.scatter3d.projecti +on.Z instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.scatter3d.Projection
+

+ +

+property scene¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

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¶

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¶

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

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.Sankey(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=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¶

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this sankey trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this sankey trace .
+
+
x
Sets the horizontal domain of this sankey trace +(in plot fraction).
+
+
y
Sets the vertical domain of this sankey trace +(in plot fraction).
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sankey.Domain
+

+ +

+property hoverinfo¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 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
+
Supported dict properties:
+
+
+
color
Sets the link color. It can be a single +value, or an array for specifying color for +each link. If link.color is omitted, then +by default, a translucent grey link will be +used.
+
+
colorscales
A tuple of plotly.graph_objects.sankey. +link.Colorscale instances or dicts with +compatible properties
+
+
colorscaledefaults
When used in a template (as layout.template.dat +a.sankey.link.colorscaledefaults), sets the +default property values to use for elements of +sankey.link.colorscales
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
customdata
Assigns extra data to each link.
+
+
customdatasrc
Sets the source reference on Chart Studio Cloud +for customdata .
+
+
hoverinfo
Determines which trace information appear when +hovering links. If none or skip are set, no +information is displayed upon hovering. But, if +none is set, click and hover events are still +fired.
+
+
hoverlabel
plotly.graph_objects.sankey.link.Hoverl +abel instance or dict with compatible +properties
+
+
hovertemplate
Template string used for rendering the +information that appear on hover box. Note that +this will override hoverinfo. Variables are +inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s +syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +for details on the formatting syntax. Dates are +formatted using d3-time-format’s syntax +%{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +for details on the date formatting syntax. The +variables available in hovertemplate are the +ones emitted as event data described at this +link https://plotly.com/javascript/plotlyjs- +events/#event-data. Additionally, every +attributes that can be specified per-point (the +ones that are arrayOk: true) are available. +variables value and label. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
+
+
hovertemplatesrc
Sets the source reference on Chart Studio Cloud +for hovertemplate .
+
+
label
The shown name of the link.
+
+
labelsrc
Sets the source reference on Chart Studio Cloud +for label .
+
+
line
plotly.graph_objects.sankey.link.Line +instance or dict with compatible properties
+
+
source
An integer number [0..nodes.length - 1] that +represents the source node.
+
+
sourcesrc
Sets the source reference on Chart Studio Cloud +for source .
+
+
target
An integer number [0..nodes.length - 1] that +represents the target node.
+
+
targetsrc
Sets the source reference on Chart Studio Cloud +for target .
+
+
value
A numeric value representing the flow volume +value.
+
+
valuesrc
Sets the source reference on Chart Studio Cloud +for value .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.sankey.Link
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the node color. It can be a single +value, or an array for specifying color for +each node. If node.color is omitted, then +the default Plotly color palette will be +cycled through to have a variety of colors. +These defaults are not fully opaque, to allow +some visibility of what is beneath the node.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
customdata
Assigns extra data to each node.
+
+
customdatasrc
Sets the source reference on Chart Studio Cloud +for customdata .
+
+
groups
Groups of nodes. Each group is defined by an +array with the indices of the nodes it +contains. Multiple groups can be specified.
+
+
hoverinfo
Determines which trace information appear when +hovering nodes. If none or skip are set, no +information is displayed upon hovering. But, if +none is set, click and hover events are still +fired.
+
+
hoverlabel
plotly.graph_objects.sankey.node.Hoverl +abel instance or dict with compatible +properties
+
+
hovertemplate
Template string used for rendering the +information that appear on hover box. Note that +this will override hoverinfo. Variables are +inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s +syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +for details on the formatting syntax. Dates are +formatted using d3-time-format’s syntax +%{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +for details on the date formatting syntax. The +variables available in hovertemplate are the +ones emitted as event data described at this +link https://plotly.com/javascript/plotlyjs- +events/#event-data. Additionally, every +attributes that can be specified per-point (the +ones that are arrayOk: true) are available. +variables value and label. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
+
+
hovertemplatesrc
Sets the source reference on Chart Studio Cloud +for hovertemplate .
+
+
label
The shown name of the node.
+
+
labelsrc
Sets the source reference on Chart Studio Cloud +for label .
+
+
line
plotly.graph_objects.sankey.node.Line +instance or dict with compatible properties
+
+
pad
Sets the padding (in px) between the nodes.
+
+
thickness
Sets the thickness (in px) of the nodes.
+
+
x
The normalized horizontal position of the node.
+
+
xsrc
Sets the source reference on Chart Studio Cloud +for x .
+
+
y
The normalized vertical position of the node.
+
+
ysrc
Sets the source reference on Chart Studio Cloud +for y .
+
+
+
+
+
+

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property valueformat¶

Sets the value formatting rule using d3 formatting mini- +language which is similar to those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#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.Pointcloud(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.pointcloud.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pointcloud.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 indices¶

The ‘indices’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property indicessrc¶

Sets the source reference on Chart Studio Cloud for indices .

The ‘indicessrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.pointcloud.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
blend
Determines if colors are blended together for a +translucency effect in case opacity is +specified as a value less then 1. Setting +blend to true reduces zoom/pan speed if +used with large numbers of points.
+
+
border
plotly.graph_objects.pointcloud.marker. +Border instance or dict with compatible +properties
+
+
color
Sets the marker fill color. It accepts a +specific color.If the color is not fully opaque +and there are hundreds of thousandsof points, +it may cause slower zooming and panning.
+
+
opacity
Sets the marker opacity. The default value is +1 (fully opaque). If the markers are not +fully opaque and there are hundreds of +thousands of points, it may cause slower +zooming and panning. Opacity fades the color +even if blend is left on false even if +there is no translucency effect in that case.
+
+
sizemax
Sets the maximum size (in px) of the rendered +marker points. Effective when the pointcloud +shows only few points.
+
+
sizemin
Sets the minimum size (in px) of the rendered +marker points, effective when the pointcloud +shows a million or more points.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pointcloud.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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 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.pointcloud.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pointcloud.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property 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 xaxis¶

Returns: +
Return type: str
+

+ +

+property xbounds¶

Specify xbounds in the shape of [xMin, xMax] to avoid +looping through the `xy typed array. Use it in conjunction +with xy and ybounds for the performance benefits.

The ‘xbounds’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xboundssrc¶

Sets the source reference on Chart Studio Cloud for xbounds .

The ‘xboundssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

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 xy¶

Faster alternative to specifying x and y separately. If +supplied, it must be a typed Float32Array array that +represents points such that xy[i * 2] = x[i] and xy[i * 2 + +1] = y[i]

The ‘xy’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xysrc¶

Sets the source reference on Chart Studio Cloud for xy .

The ‘xysrc’ 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 yaxis¶

Returns: +
Return type: str
+

+ +

+property ybounds¶

Specify ybounds in the shape of [yMin, yMax] to avoid +looping through the `xy typed array. Use it in conjunction +with xy and xbounds for the performance benefits.

The ‘ybounds’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property yboundssrc¶

Sets the source reference on Chart Studio Cloud for ybounds .

The ‘yboundssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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, titlefont=None, titleposition=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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this pie trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this pie trace .
+
+
x
Sets the horizontal domain of this pie trace +(in plot fraction).
+
+
y
Sets the vertical domain of this pie trace (in +plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Insidetextfont
+

+ +

+property insidetextorientation¶

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¶

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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.pie.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
colors
Sets the color of each sector. If not +specified, the default trace color set is used +to pick the sector colors.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
line
plotly.graph_objects.pie.marker.Line +instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 number and may be specified as:

An int or float in the interval [-360, 360]

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
font
Sets the font used for title. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
position
Specifies the location of the title. Note +that the title’s position used to be set by the +now deprecated titleposition attribute.
+
+
text
Sets the title of the chart. If it is empty, no +title is displayed. Note that before the +existence of title.text, the title’s contents +used to be defined as the title attribute +itself. This behavior has been deprecated.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.pie.Title
+

+ +

+property titlefont¶

Please use pie.title.font instead. Sets the font +used for title. Note that the title’s font used to be set by +the now deprecated titlefont attribute.

The ‘font’ property is an instance of Font +that may be specified as:

+
+
An instance of plotly.graph_objects.pie.title.Font
+
A dict of string/value properties that will be passed +to the Font constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Type: Deprecated
+

+ +

+property titleposition¶

Please use pie.title.position instead. Specifies +the location of the title. Note that the title’s position +used to be set by the now deprecated titleposition attribute.

The ‘position’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘top left’, ‘top center’, ‘top right’, ‘middle center’, +‘bottom left’, ‘bottom center’, ‘bottom right’]
+
+
+

Type: Deprecated
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property 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.Parcoords(arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
constraintrange
The domain range to which the filter on the +dimension is constrained. Must be an array of +[fromValue, toValue] with fromValue <= +toValue, or if multiselect is not disabled, +you may give an array of arrays, where each +inner array is [fromValue, toValue].
+
+
label
The shown name of the dimension.
+
+
multiselect
Do we allow multiple selection ranges or just a +single range?
+
+
name
When used in a template, named items are +created in the output figure in addition to any +items the figure already has in this array. You +can modify these items in the output figure by +making your own item with templateitemname +matching this name alongside your +modifications (including visible: false or +enabled: false to hide it). Has no effect +outside of a template.
+
+
range
The domain range that represents the full, +shown axis extent. Defaults to the values +extent. Must be an array of [fromValue, +toValue] with finite numbers as elements.
+
+
templateitemname
Used to refer to a named item in this array in +the template. Named items from the template +will be created even without a matching item in +the input figure, but you can modify one by +making an item with templateitemname matching +its name, alongside your modifications +(including visible: false or enabled: false +to hide it). If there is no template or no +matching item, this item will be hidden unless +you explicitly show it with visible: true.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
values
Dimension values. values[n] represents the +value of the n`th point in the dataset, +therefore the `values vector for all +dimensions must be the same (longer vectors +will be truncated). Each value must be a finite +number.
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
visible
Shows the dimension when set to true (the +default). Hides the dimension for false.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this parcoords +trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this parcoords trace .
+
+
x
Sets the horizontal domain of this parcoords +trace (in plot fraction).
+
+
y
Sets the vertical domain of this parcoords +trace (in plot fraction).
+
+
+
+
+
+

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¶

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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcoords.Labelfont
+

+ +

+property labelside¶

The ‘labelside’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘top’, ‘bottom’]
+
+
+

Returns: +
Return type: Any
+

+ +

+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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by line.colorscale. Has an effect +only if in line.color`is set to a numerical +array. In case `colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in line.color) or the bounds set in +line.cmin and line.cmax Has an effect only +if in line.color`is set to a numerical array. +Defaults to `false when line.cmin and +line.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling line.cmin and/or line.cmax to be +equidistant to this point. Has an effect only +if in line.color`is set to a numerical array. +Value should have the same units as in +`line.color. Has no effect when line.cauto +is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmax must be set as well.
+
+
color
Sets thelinecolor. It accepts either a specific +color or an array of numbers that are mapped to +the colorscale relative to the max and min +values of the array or relative to line.cmin +and line.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.parcoords.line.Col +orBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +line.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`line.cmin` and line.cmax. +Alternatively, colorscale may be a palette +name string of the following list: Greys,YlGnBu +,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R +ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri +c,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in line.color`is set to a +numerical array. If true, `line.cmin will +correspond to the last color in the array and +line.cmax will correspond to the first color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `line.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcoords.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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.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, 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¶

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
+
Supported dict properties:
+
+
+

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
+
Supported dict properties:
+
+
+
categoryarray
Sets the order in which categories in this +dimension appear. Only has an effect if +categoryorder is set to “array”. Used with +categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the categories +in the dimension. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray.
+
+
displayindex
The display index of dimension, from left to +right, zero indexed, defaults to dimension +index.
+
+
label
The shown name of the dimension.
+
+
ticktext
Sets alternative tick labels for the categories +in this dimension. Only has an effect if +categoryorder is set to “array”. Should be an +array the same length as categoryarray Used +with categoryorder.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
values
Dimension values. values[n] represents the +category value of the n`th point in the +dataset, therefore the `values vector for all +dimensions must be the same (longer vectors +will be truncated).
+
+
valuessrc
Sets the source reference on Chart Studio Cloud +for values .
+
+
visible
Shows the dimension when set to true (the +default). Hides the dimension for false.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this parcats trace +.
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this parcats trace .
+
+
x
Sets the horizontal domain of this parcats +trace (in plot fraction).
+
+
y
Sets the vertical domain of this parcats trace +(in plot fraction).
+
+
+
+
+
+

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¶

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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcats.Labelfont
+

+ +

+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
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by line.colorscale. Has an effect +only if in line.color`is set to a numerical +array. In case `colorscale is unspecified or +autocolorscale is true, the default palette +will be chosen according to whether numbers in +the color array are all positive, all +negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in line.color) or the bounds set in +line.cmin and line.cmax Has an effect only +if in line.color`is set to a numerical array. +Defaults to `false when line.cmin and +line.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling line.cmin and/or line.cmax to be +equidistant to this point. Has an effect only +if in line.color`is set to a numerical array. +Value should have the same units as in +`line.color. Has no effect when line.cauto +is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in line.color`is set to a +numerical array. Value should have the same +units as in `line.color and if set, +line.cmax must be set as well.
+
+
color
Sets thelinecolor. It accepts either a specific +color or an array of numbers that are mapped to +the colorscale relative to the max and min +values of the array or relative to line.cmin +and line.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.parcats.line.Color +Bar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +line.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`line.cmin` and line.cmax. +Alternatively, colorscale may be a palette +name string of the following list: Greys,YlGnBu +,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R +ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri +c,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
hovertemplate
Template string used for rendering the +information that appear on hover box. Note that +this will override hoverinfo. Variables are +inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s +syntax %{variable:d3-format}, for example +“Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +for details on the formatting syntax. Dates are +formatted using d3-time-format’s syntax +%{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +for details on the date formatting syntax. The +variables available in hovertemplate are the +ones emitted as event data described at this +link https://plotly.com/javascript/plotlyjs- +events/#event-data. Additionally, every +attributes that can be specified per-point (the +ones that are arrayOk: true) are available. +variables count and probability. Anything +contained in tag <extra> is displayed in the +secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the +secondary box completely, use an empty tag +<extra></extra>.
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in line.color`is set to a +numerical array. If true, `line.cmin will +correspond to the last color in the array and +line.cmax will correspond to the first color.
+
+
shape
Sets the shape of the paths. If linear, paths +are composed of straight lines. If hspline, +paths are composed of horizontal curved splines
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `line.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.parcats.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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.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, legendgroup=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property close¶

Sets the close values.

The ‘close’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property closesrc¶

Sets the source reference on Chart Studio Cloud for close .

The ‘closesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property decreasing¶

The ‘decreasing’ property is an instance of Decreasing +that may be specified as:

+
+
An instance of plotly.graph_objects.ohlc.Decreasing
+
A dict of string/value properties that will be passed +to the Decreasing constructor
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.ohlc.decreasing.Li +ne instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
split
Show hover information (open, close, high, low) +in separate labels.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.ohlc.increasing.Li +ne instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.ohlc.Increasing
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.ohlc.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”). +Note that this style setting can also be set +per direction via increasing.line.dash and +decreasing.line.dash.
+
+
width
[object Object] Note that this style setting +can also be set per direction via +increasing.line.width and +decreasing.line.width.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property open¶

Sets the open values.

The ‘open’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property opensrc¶

Sets the source reference on Chart Studio Cloud for open .

The ‘opensrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.ohlc.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.ohlc.Stream
+

+ +

+property text¶

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¶

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¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=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, xsrc=None, y=None, ycalendar=None, ysrc=None, z=None, zcalendar=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alphahull¶

The ‘alphahull’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property cauto¶

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:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+
A number that will be interpreted as a color +according to mesh3d.colorscale

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.mesh3d.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.mesh3d. +colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.mesh3d.colorbar.tickformatstopdefaults), sets +the default property values to use for elements +of mesh3d.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.mesh3d.colorbar.Ti +tle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +mesh3d.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +mesh3d.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.mesh3d.ColorBar
+

+ +

+property colorscale¶

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the color of the contour lines.
+
+
show
Sets whether or not dynamic contours are shown +on hover
+
+
width
Sets the width of the contour lines.
+
+
+
+
+
+

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¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

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¶

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¶

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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

The ‘lighting’ property is an instance of Lighting +that may be specified as:

+
+
An instance of plotly.graph_objects.mesh3d.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.mesh3d.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property vertexcolor¶

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the Y coordinates 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

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.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, legendgroup=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, valuesrc=None, visible=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property 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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.isosurface.caps.X +instance or dict with compatible properties
+
+
y
plotly.graph_objects.isosurface.caps.Y +instance or dict with compatible properties
+
+
z
plotly.graph_objects.isosurface.caps.Z +instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.isosurface.Caps
+

+ +

+property cauto¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.isosurf +ace.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.isosurface.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of isosurface.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.isosurface.colorba +r.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +isosurface.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +isosurface.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.isosurface.ColorBar
+

+ +

+property colorscale¶

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
color
Sets the color of the contour lines.
+
+
show
Sets whether or not dynamic contours are shown +on hover
+
+
width
Sets the width of the contour lines.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

The ‘lighting’ property is an instance of Lighting +that may be specified as:

+
+
An instance of plotly.graph_objects.isosurface.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.isosurface.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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
+
Supported dict properties:
+
+
+
x
plotly.graph_objects.isosurface.slices. +X instance or dict with compatible properties
+
+
y
plotly.graph_objects.isosurface.slices. +Y instance or dict with compatible properties
+
+
z
plotly.graph_objects.isosurface.slices. +Z instance or dict with compatible properties
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
fill
Sets the fill ratio of the spaceframe +elements. The default fill value is 0.15 +meaning that only 15% of the area of every +faces of tetras would be shaded. Applying a +greater fill ratio would allow the creation +of stronger elements or could be sued to have +entirely closed areas (in case of using 1).
+
+
show
Displays/hides tetrahedron shapes between +minimum and maximum iso-values. Often useful +when either caps or surfaces are disabled or +filled with values less than 1.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
count
Sets the number of iso-surfaces between minimum +and maximum iso-values. By default this value +is 2 meaning that only minimum and maximum +surfaces would be drawn.
+
+
fill
Sets the fill ratio of the iso-surface. The +default fill value of the surface is 1 meaning +that they are entirely shaded. On the other +hand Applying a fill ratio less than one +would allow the creation of openings parallel +to the edges.
+
+
pattern
Sets the surface pattern of the iso-surface 3-D +sections. The default pattern of the surface is +all meaning that the rest of surface elements +would be shaded. The check options (either 1 or +2) could be used to draw half of the squares on +the surface. Using various combinations of +capital A, B, C, D and E may also be +used to reduce the number of triangles on the +iso-surfaces and creating other patterns of +interest.
+
+
show
Hides/displays surfaces between minimum and +maximum iso-values.
+
+
+
+
+
+

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¶

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 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 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 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 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, 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
+
Supported dict properties:
+
+
+
decreasing
plotly.graph_objects.indicator.delta.De +creasing instance or dict with compatible +properties
+
+
font
Set the font used to display the delta
+
+
increasing
plotly.graph_objects.indicator.delta.In +creasing instance or dict with compatible +properties
+
+
position
Sets the position of delta with respect to the +number.
+
+
reference
Sets the reference value to compute the delta. +By default, it is set to the current value.
+
+
relative
Show relative change
+
+
valueformat
Sets the value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this indicator +trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this indicator trace .
+
+
x
Sets the horizontal domain of this indicator +trace (in plot fraction).
+
+
y
Sets the vertical domain of this indicator +trace (in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
axis
plotly.graph_objects.indicator.gauge.Ax +is instance or dict with compatible properties
+
+
bar
Set the appearance of the gauge’s value
+
+
bgcolor
Sets the gauge background color.
+
+
bordercolor
Sets the color of the border enclosing the +gauge.
+
+
borderwidth
Sets the width (in px) of the border enclosing +the gauge.
+
+
shape
Set the shape of the gauge
+
+
steps
A tuple of plotly.graph_objects.indicat +or.gauge.Step instances or dicts with +compatible properties
+
+
stepdefaults
When used in a template (as layout.template.dat +a.indicator.gauge.stepdefaults), sets the +default property values to use for elements of +indicator.gauge.steps
+
+
threshold
plotly.graph_objects.indicator.gauge.Th +reshold instance or dict with compatible +properties
+
+
+
+
+
+

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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property mode¶

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 appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
font
Set the font used to display main number
+
+
prefix
Sets a prefix appearing before the number.
+
+
suffix
Sets a suffix appearing next to the number.
+
+
valueformat
Sets the value formatting rule using d3 +formatting mini-language which is similar to +those of Python. See +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the title. It +defaults to center except for bullet charts +for which it defaults to right.
+
+
font
Set the font used to display the title
+
+
text
Sets the title of this indicator.
+
+
+
+
+
+

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¶

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.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, meta=None, metasrc=None, name=None, opacity=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, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property colormodel¶

Color model used to map the numerical color components +described in z into colors.

The ‘colormodel’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘rgb’, ‘rgba’, ‘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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.image.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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 ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property y0¶

Set the image’s y position.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

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

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

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 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, 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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property autobinx¶

The ‘autobinx’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autobiny¶

The ‘autobiny’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property 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 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
+
Supported dict properties:
+
+
+
currentbin
Only applies if cumulative is enabled. Sets +whether the current bin is included, excluded, +or has half of its value included in the +current cumulative value. “include” is the +default for compatibility with various other +tools, however it introduces a half-bin bias to +the results. “exclude” makes the opposite half- +bin bias, and “half” removes it.
+
+
direction
Only applies if cumulative is enabled. If +“increasing” (default) we sum all prior bins, +so the result increases from left to right. If +“decreasing” we sum later bins so the result +decreases from left to right.
+
+
enabled
If true, display the cumulative distribution by +summing the binned values. Use the direction +and centralbin attributes to tune the +accumulation method. Note: in this mode, the +“density” histnorm settings behave the same +as their equivalents without “density”: “” and +“density” both rise to the number of data +points, and “probability” and probability +density both rise to the number of sample +points.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.ErrorY
+

+ +

+property histfunc¶

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¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable 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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.histogram.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.histogram.marker.C +olorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.histogram.marker.L +ine instance or dict with compatible +properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property nbinsx¶

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¶

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 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
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.histogram.selected +.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.histogram.selected +.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.histogram.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.histogram.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.histogram.unselect +ed.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.histogram.unselect +ed.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

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¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the x axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each x axis bin. Default +behavior: If nbinsx is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsx is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1). If multiple non-overlaying histograms +share a subplot, the first explicit size is +used and all others discarded. If no size is +provided,the sample data from all traces is +combined to determine size as described +above.
+
+
start
Sets the starting value for the x axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5. If multiple non- +overlaying histograms share a subplot, the +first explicit start is used exactly and all +others are shifted down (if necessary) to +differ from that one by an integer number of +bins.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the 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¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the y axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each y axis bin. Default +behavior: If nbinsy is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsy is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1). If multiple non-overlaying histograms +share a subplot, the first explicit size is +used and all others discarded. If no size is +provided,the sample data from all traces is +combined to determine size as described +above.
+
+
start
Sets the starting value for the y axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5. If multiple non- +overlaying histograms share a subplot, the +first explicit start is used exactly and all +others are shifted down (if necessary) to +differ from that one by an integer number of +bins.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=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¶

The ‘autobinx’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autobiny¶

The ‘autobiny’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autocolorscale¶

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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.histogr +am2d.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.histogram2d.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of +histogram2d.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.histogram2d.colorb +ar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +histogram2d.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +histogram2d.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property histfunc¶

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¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable 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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.histogram2d.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
color
Sets the aggregation data.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2d.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property nbinsx¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2d.Stream
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

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¶

Returns: +
Return type: str
+

+ +

+property xbingroup¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the x axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each x axis bin. Default +behavior: If nbinsx is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsx is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the x axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘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 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¶

Returns: +
Return type: str
+

+ +

+property ybingroup¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the y axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each y axis bin. Default +behavior: If nbinsy is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsy is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the y axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘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 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¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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, legendgroup=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, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autobinx¶

The ‘autobinx’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autobiny¶

The ‘autobiny’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+
Type: Obsolete
+

+ +

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property autocontour¶

The ‘autocontour’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property 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¶

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
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.histogr +am2dcontour.colorbar.Tickformatstop instances +or dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.histogram2dcontour.colorbar.tickformatstopdef +aults), sets the default property values to use +for elements of +histogram2dcontour.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.histogram2dcontour +.colorbar.Title instance or dict with +compatible properties
+
+
titlefont
Deprecated: Please use +histogram2dcontour.colorbar.title.font instead. +Sets this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +histogram2dcontour.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
coloring
Determines the coloring method showing the +contour values. If “fill”, coloring is done +evenly between each contour level If “heatmap”, +a heatmap gradient coloring is applied between +each contour level. If “lines”, coloring is +done on the contour lines. If “none”, no +coloring is applied on this trace.
+
+
end
Sets the end contour level value. Must be more +than contours.start
+
+
labelfont
Sets the font used for labeling the contour +levels. The default color comes from the lines, +if shown. The default family and size come from +layout.font.
+
+
labelformat
Sets the contour label formatting rule using d3 +formatting mini-language which is very similar +to Python, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
operation
Sets the constraint operation. “=” keeps +regions equal to value “<” and “<=” keep +regions less than value “>” and “>=” keep +regions greater than value “[]”, “()”, “[)”, +and “(]” keep regions inside value[0] to +value[1] “][“, “)(“, “](“, “)[” keep regions +outside value[0] to value[1]` Open vs. closed +intervals make no difference to constraint +display, but all versions are allowed for +consistency with filter transforms.
+
+
showlabels
Determines whether to label the contour lines +with their values.
+
+
showlines
Determines whether or not the contour lines are +drawn. Has an effect only if +contours.coloring is set to “fill”.
+
+
size
Sets the step between each contour level. Must +be positive.
+
+
start
Sets the starting contour level value. Must be +less than contours.end
+
+
type
If levels, the data is represented as a +contour plot with multiple levels displayed. If +constraint, the data is represented as +constraints with the invalid region shaded as +specified by the operation and value +parameters.
+
+
value
Sets the value or values of the constraint +boundary. When operation is set to one of the +comparison values (=,<,>=,>,<=) “value” is +expected to be a number. When operation is +set to one of the interval values +([],(),[),(],][,)(,](,)[) “value” is expected +to be an array of two numbers where the first +is the lower bound and the second is the upper +bound.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable 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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.histogram2dcontour.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of the contour level. Has no +effect if contours.coloring is set to +“lines”.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
smoothing
Sets the amount of smoothing for the contour +lines, where 0 corresponds to no smoothing.
+
+
width
Sets the contour line width in (in px)
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
color
Sets the aggregation data.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2dcontour.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property nbinsx¶

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¶

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¶

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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.histogram2dcontour.Stream
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

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¶

Returns: +
Return type: str
+

+ +

+property xbingroup¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the x axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each x axis bin. Default +behavior: If nbinsx is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsx is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the x axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the 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¶

Returns: +
Return type: str
+

+ +

+property ybingroup¶

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
+
Supported dict properties:
+
+
+
end
Sets the end value for the y axis bins. The +last bin may not end exactly at this value, we +increment the bin edge by size from start +until we reach or exceed end. Defaults to the +maximum data value. Like start, for dates use +a date string, and for category data end is +based on the category serial numbers.
+
+
size
Sets the size of each y axis bin. Default +behavior: If nbinsy is 0 or omitted, we +choose a nice round bin size such that the +number of bins is about the same as the typical +number of samples in each bin. If nbinsy is +provided, we choose a nice round bin size +giving no more than that many bins. For date +data, use milliseconds or “M<n>” for months, as +in axis.dtick. For category data, the number +of categories to bin together (always defaults +to 1).
+
+
start
Sets the starting value for the y axis bins. +Defaults to the minimum data value, shifted +down if necessary to make nice round values and +to remove ambiguous bin edges. For example, if +most of the data is integers we shift the bin +edges 0.5 down, so a size of 5 would have a +default start of -0.5, so it is clear that +0-4 are in the first bin, 5-9 in the second, +but continuous data gets a start of 0 and bins +[0,5), [5,10) etc. Dates behave similarly, and +start should be a date string. For category +data, start is based on the category serial +numbers, and defaults to -0.5.
+
+
+
+
+
+

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:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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.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, legendgroup=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.heatmap.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.heatmap +.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.heatmap.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of heatmap.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.heatmap.colorbar.T +itle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +heatmap.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +heatmap.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property connectgaps¶

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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 textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

The ‘transpose’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Alternate to x. Builds a linear space of x coordinates. Use +with dx where x0 is the starting coordinate and dx the +step.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property 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 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¶

The ‘xtype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property 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 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¶

The ‘ytype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the z data.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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.Heatmapgl(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.heatmapgl.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.heatmap +gl.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.heatmapgl.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of heatmapgl.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.heatmapgl.colorbar +.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +heatmapgl.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +heatmapgl.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.heatmapgl.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property 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.heatmapgl.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.heatmapgl.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 meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property 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 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.heatmapgl.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.heatmapgl.Stream
+

+ +

+property text¶

Sets the text elements associated with each z value.

The ‘text’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

The ‘transpose’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Alternate to x. Builds a linear space of x coordinates. Use +with dx where x0 is the starting coordinate and dx the +step.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property 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¶

The ‘xtype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property 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¶

The ‘ytype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the z data.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property 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, legendgroup=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, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
fillcolor
Sets the fill color.
+
+
line
plotly.graph_objects.funnel.connector.L +ine instance or dict with compatible +properties
+
+
visible
Determines if connector regions and lines are +drawn.
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnel.Insidetextfont
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.funnel.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.funnel.marker.Colo +rBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
:class:`plotly.graph_objects.funnel.marker.Line +` instance or dict with compatible properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnel.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

Shifts the position where the bar is drawn (in position axis +units). In “group” barmode, traces that set “offset” will be +excluded and drawn in “overlay” mode instead.

The ‘offset’ property is a number and may be specified as:

An int or float

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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnel.Outsidetextfont
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.funnel.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnel.Stream
+

+ +

+property text¶

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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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¶

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¶

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¶

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 y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property 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.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, legendgroup=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
+
Supported dict properties:
+
+
+
column
If there is a layout grid, use the domain for +this column in the grid for this funnelarea +trace .
+
+
row
If there is a layout grid, use the domain for +this row in the grid for this funnelarea trace +.
+
+
x
Sets the horizontal domain of this funnelarea +trace (in plot fraction).
+
+
y
Sets the vertical domain of this funnelarea +trace (in plot fraction).
+
+
+
+
+
+

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
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables 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¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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 legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.funnelarea.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
colors
Sets the color of each sector. If not +specified, the default trace color set is used +to pick the sector colors.
+
+
colorssrc
Sets the source reference on Chart Studio Cloud +for colors .
+
+
line
plotly.graph_objects.funnelarea.marker. +Line instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnelarea.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property 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
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.funnelarea.Stream
+

+ +

+property text¶

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
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.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¶

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
+
Supported dict properties:
+
+
+
font
Sets the font used for title. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
position
Specifies the location of the title. Note +that the title’s position used to be set by the +now deprecated titleposition attribute.
+
+
text
Sets the title of the chart. If it is empty, no +title is displayed. Note that before the +existence of title.text, the title’s contents +used to be defined as the title attribute +itself. This behavior has been deprecated.
+
+
+
+
+
+

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¶

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.Densitymapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legendgroup=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property below¶

The ‘below’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.densitymapbox.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.density +mapbox.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.densitymapbox.colorbar.tickformatstopdefaults +), sets the default property values to use for +elements of +densitymapbox.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.densitymapbox.colo +rbar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +densitymapbox.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +densitymapbox.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.densitymapbox.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘lon’, ‘lat’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘lon+lat’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.densitymapbox.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.densitymapbox.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property lat¶

Sets the latitude coordinates (in degrees North).

The ‘lat’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property latsrc¶

Sets the source reference on Chart Studio Cloud for lat .

The ‘latsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lon¶

Sets the longitude coordinates (in degrees East).

The ‘lon’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property lonsrc¶

Sets the source reference on Chart Studio Cloud for lon .

The ‘lonsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property radius¶

Sets the radius of influence of one lon / lat point in +pixels. Increasing the value makes the densitymapbox trace +smoother, but less detailed.

The ‘radius’ property is a number and may be specified as:

An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property radiussrc¶

Sets the source reference on Chart Studio Cloud for radius .

The ‘radiussrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.densitymapbox.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.densitymapbox.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the points’ weight. For example, a value of 10 would be +equivalent to having 10 points of weight 1 in the same spot

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zmax¶

Sets the upper bound of the color domain. Value should have the +same units as in z and if set, zmin must be set as well.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

Sets the mid-point of the color domain by scaling zmin and/or +zmax to be equidistant to this point. Value should have the +same units as in z. Has no effect when zauto is false.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

Sets the lower bound of the color domain. Value should have the +same units as in z and if set, zmax must be set as well.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property autocontour¶

The ‘autocontour’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.contour.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.contour +.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.contour.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of contour.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.contour.colorbar.T +itle instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +contour.colorbar.title.font instead. Sets this +color bar’s title font. Note that the title’s +font used to be set by the now deprecated +titlefont attribute.
+
+
titleside
Deprecated: Please use +contour.colorbar.title.side instead. Determines +the location of color bar’s title with respect +to the color bar. Note that the title’s +location used to be set by the now deprecated +titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property connectgaps¶

Determines whether or not gaps (i.e. {nan} or missing values) +in the z data are filled in. It is defaulted to true if z +is a one dimensional array otherwise it is defaulted to false.

The ‘connectgaps’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property contours¶

The ‘contours’ property is an instance of Contours +that may be specified as:

+
+
An instance of plotly.graph_objects.contour.Contours
+
A dict of string/value properties that will be passed +to the Contours constructor
+
Supported dict properties:
+
+
+
coloring
Determines the coloring method showing the +contour values. If “fill”, coloring is done +evenly between each contour level If “heatmap”, +a heatmap gradient coloring is applied between +each contour level. If “lines”, coloring is +done on the contour lines. If “none”, no +coloring is applied on this trace.
+
+
end
Sets the end contour level value. Must be more +than contours.start
+
+
labelfont
Sets the font used for labeling the contour +levels. The default color comes from the lines, +if shown. The default family and size come from +layout.font.
+
+
labelformat
Sets the contour label formatting rule using d3 +formatting mini-language which is very similar +to Python, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
operation
Sets the constraint operation. “=” keeps +regions equal to value “<” and “<=” keep +regions less than value “>” and “>=” keep +regions greater than value “[]”, “()”, “[)”, +and “(]” keep regions inside value[0] to +value[1] “][“, “)(“, “](“, “)[” keep regions +outside value[0] to value[1]` Open vs. closed +intervals make no difference to constraint +display, but all versions are allowed for +consistency with filter transforms.
+
+
showlabels
Determines whether to label the contour lines +with their values.
+
+
showlines
Determines whether or not the contour lines are +drawn. Has an effect only if +contours.coloring is set to “fill”.
+
+
size
Sets the step between each contour level. Must +be positive.
+
+
start
Sets the starting contour level value. Must be +less than contours.end
+
+
type
If levels, the data is represented as a +contour plot with multiple levels displayed. If +constraint, the data is represented as +constraints with the invalid region shaded as +specified by the operation and value +parameters.
+
+
value
Sets the value or values of the constraint +boundary. When operation is set to one of the +comparison values (=,<,>=,>,<=) “value” is +expected to be a number. When operation is +set to one of the interval values +([],(),[),(],][,)(,](,)[) “value” is expected +to be an array of two numbers where the first +is the lower bound and the second is the upper +bound.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Contours
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dx¶

Sets the x coordinate step. See x0 for more info.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dy¶

Sets the y coordinate step. See y0 for more info.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property fillcolor¶

Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line color, +marker color, or marker line color, whichever is available.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
+
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+
A number that will be interpreted as a color +according to contour.colorscale

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.contour.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Hoverlabel
+

+ +

+property hoverongaps¶

Determines whether or not gaps (i.e. {nan} or missing values) +in the z data have hover labels associated with them.

The ‘hoverongaps’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.contour.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of the contour level. Has no +effect if contours.coloring is set to +“lines”.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
smoothing
Sets the amount of smoothing for the contour +lines, where 0 corresponds to no smoothing.
+
+
width
Sets the contour line width in (in px) Defaults +to 0.5 when contours.type is “levels”. +Defaults to 2 when contour.type is +“constraint”.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property ncontours¶

The ‘ncontours’ property is a integer and may be specified as:

An int (or float that will be cast to an int) +in the interval [1, 9223372036854775807]

Returns: +
Return type: int
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.contour.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contour.Stream
+

+ +

+property text¶

Sets the text elements associated with each z value.

The ‘text’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

The ‘transpose’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Alternate to x. Builds a linear space of x coordinates. Use +with dx where x0 is the starting coordinate and dx the +step.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property xtype¶

The ‘xtype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ytype¶

The ‘ytype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the z data.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zhoverformat¶

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.Contourcarpet(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property a¶

Sets the x coordinates.

The ‘a’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property a0¶

Alternate to x. Builds a linear space of x coordinates. Use +with dx where x0 is the starting coordinate and dx the +step.

The ‘a0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property asrc¶

Sets the source reference on Chart Studio Cloud for a .

The ‘asrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property atype¶

The ‘atype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property autocontour¶

The ‘autocontour’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property b¶

Sets the y coordinates.

The ‘b’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property b0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘b0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property bsrc¶

Sets the source reference on Chart Studio Cloud for b .

The ‘bsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property btype¶

The ‘btype’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘array’, ‘scaled’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property carpet¶

The carpet of the carpet axes on which this contour trace +lies

The ‘carpet’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.contourcarpet.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.contour +carpet.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.contourcarpet.colorbar.tickformatstopdefaults +), sets the default property values to use for +elements of +contourcarpet.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.contourcarpet.colo +rbar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +contourcarpet.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +contourcarpet.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property contours¶

The ‘contours’ property is an instance of Contours +that may be specified as:

+
+
An instance of plotly.graph_objects.contourcarpet.Contours
+
A dict of string/value properties that will be passed +to the Contours constructor
+
Supported dict properties:
+
+
+
coloring
Determines the coloring method showing the +contour values. If “fill”, coloring is done +evenly between each contour level If “lines”, +coloring is done on the contour lines. If +“none”, no coloring is applied on this trace.
+
+
end
Sets the end contour level value. Must be more +than contours.start
+
+
labelfont
Sets the font used for labeling the contour +levels. The default color comes from the lines, +if shown. The default family and size come from +layout.font.
+
+
labelformat
Sets the contour label formatting rule using d3 +formatting mini-language which is very similar +to Python, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format
+
+
operation
Sets the constraint operation. “=” keeps +regions equal to value “<” and “<=” keep +regions less than value “>” and “>=” keep +regions greater than value “[]”, “()”, “[)”, +and “(]” keep regions inside value[0] to +value[1] “][“, “)(“, “](“, “)[” keep regions +outside value[0] to value[1]` Open vs. closed +intervals make no difference to constraint +display, but all versions are allowed for +consistency with filter transforms.
+
+
showlabels
Determines whether to label the contour lines +with their values.
+
+
showlines
Determines whether or not the contour lines are +drawn. Has an effect only if +contours.coloring is set to “fill”.
+
+
size
Sets the step between each contour level. Must +be positive.
+
+
start
Sets the starting contour level value. Must be +less than contours.end
+
+
type
If levels, the data is represented as a +contour plot with multiple levels displayed. If +constraint, the data is represented as +constraints with the invalid region shaded as +specified by the operation and value +parameters.
+
+
value
Sets the value or values of the constraint +boundary. When operation is set to one of the +comparison values (=,<,>=,>,<=) “value” is +expected to be a number. When operation is +set to one of the interval values +([],(),[),(],][,)(,](,)[) “value” is expected +to be an array of two numbers where the first +is the lower bound and the second is the upper +bound.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.Contours
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property da¶

Sets the x coordinate step. See x0 for more info.

The ‘da’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property db¶

Sets the y coordinate step. See y0 for more info.

The ‘db’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property fillcolor¶

Sets the fill color if contours.type is “constraint”. +Defaults to a half-transparent variant of the line color, +marker color, or marker line color, whichever is available.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
+
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+
A number that will be interpreted as a color +according to contourcarpet.colorscale

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.contourcarpet.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of the contour level. Has no +effect if contours.coloring is set to +“lines”.
+
+
dash
Sets the dash style of lines. Set to a dash +type string (“solid”, “dot”, “dash”, +“longdash”, “dashdot”, or “longdashdot”) or a +dash length list in px (eg “5px,10px,2px,2px”).
+
+
smoothing
Sets the amount of smoothing for the contour +lines, where 0 corresponds to no smoothing.
+
+
width
Sets the contour line width in (in px) Defaults +to 0.5 when contours.type is “levels”. +Defaults to 2 when contour.type is +“constraint”.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.Line
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property ncontours¶

The ‘ncontours’ property is a integer and may be specified as:

An int (or float that will be cast to an int) +in the interval [1, 9223372036854775807]

Returns: +
Return type: int
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.contourcarpet.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.contourcarpet.Stream
+

+ +

+property text¶

Sets the text elements associated with each z value.

The ‘text’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property transpose¶

Transposes the z data.

The ‘transpose’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property z¶

Sets the z data.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zmax¶

Sets the upper bound of the color domain. Value should have the +same units as in z and if set, zmin must be set as well.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

Sets the mid-point of the color domain by scaling zmin and/or +zmax to be equidistant to this point. Value should have the +same units as in z. Has no effect when zauto is false.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

Sets the lower bound of the color domain. Value should have the +same units as in z and if set, zmax must be set as well.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uid=None, uirevision=None, usrc=None, v=None, visible=None, vsrc=None, w=None, wsrc=None, x=None, xsrc=None, y=None, ysrc=None, z=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property anchor¶

Sets the cones’ anchor with respect to their x/y/z positions. +Note that “cm” denote the cone’s center of mass which +corresponds to 1/4 from the tail to tip.

The ‘anchor’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘tip’, ‘tail’, ‘cm’, ‘center’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property cauto¶

The ‘cauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property cmax¶

Sets the upper bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmin must be set as +well.

The ‘cmax’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmid¶

Sets the mid-point of the color domain by scaling cmin and/or +cmax to be equidistant to this point. Value should have the +same units as u/v/w norm. Has no effect when cauto is +false.

The ‘cmid’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property cmin¶

Sets the lower bound of the color domain. Value should have the +same units as u/v/w norm and if set, cmax must be set as +well.

The ‘cmin’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.cone.co +lorbar.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.cone.colorbar.tickformatstopdefaults), sets +the default property values to use for elements +of cone.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.cone.colorbar.Titl +e instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use cone.colorbar.title.font +instead. Sets this color bar’s title font. Note +that the title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use cone.colorbar.title.side +instead. Determines the location of color bar’s +title with respect to the color bar. Note that +the title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.ColorBar
+

+ +

+property colorscale¶

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘u’, ‘v’, ‘w’, ‘norm’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable norm Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary box +completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property lighting¶

The ‘lighting’ property is an instance of Lighting +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Lighting
+
A dict of string/value properties that will be passed +to the Lighting constructor
+
Supported dict properties:
+
+
+
ambient
Ambient light increases overall color +visibility but can wash out the image.
+
+
diffuse
Represents the extent that incident rays are +reflected in a range of angles.
+
+
facenormalsepsilon
Epsilon for face normals calculation avoids +math issues arising from degenerate geometry.
+
+
fresnel
Represents the reflectance as a dependency of +the viewing angle; e.g. paper is reflective +when viewing it from the edge of the paper +(almost 90 degrees), causing shine.
+
+
roughness
Alters specular reflection; the rougher the +surface, the wider and less contrasty the +shine.
+
+
specular
Represents the level that incident rays are +reflected in a single direction, causing shine.
+
+
vertexnormalsepsilon
Epsilon for vertex normals calculation avoids +math issues arising from degenerate geometry.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Lighting
+

+ +

+property lightposition¶

The ‘lightposition’ property is an instance of Lightposition +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Lightposition
+
A dict of string/value properties that will be passed +to the Lightposition constructor
+
Supported dict properties:
+
+
+
x
Numeric vector, representing the X coordinate +for each vertex.
+
+
y
Numeric vector, representing the Y coordinate +for each vertex.
+
+
z
Numeric vector, representing the Z coordinate +for each vertex.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Lightposition
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

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¶

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¶

The ‘sizemode’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘scaled’, ‘absolute’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property sizeref¶

The ‘sizeref’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns: +
Return type: int|float
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.cone.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.cone.Stream
+

+ +

+property text¶

Sets the text elements associated with the cones. If trace +hoverinfo contains a “text” flag and “hovertext” is not set, +these elements will be seen in the hover labels.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property u¶

Sets the x components of the vector field.

The ‘u’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property usrc¶

Sets the source reference on Chart Studio Cloud for u .

The ‘usrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property v¶

Sets the y components of the vector field.

The ‘v’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property vsrc¶

Sets the source reference on Chart Studio Cloud for v .

The ‘vsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property w¶

Sets the z components of the vector field.

The ‘w’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property wsrc¶

Sets the source reference on Chart Studio Cloud for w .

The ‘wsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property x¶

Sets the x coordinates of the vector field and of the displayed +cones.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates of the vector field and of the displayed +cones.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property z¶

Sets the z coordinates of the vector field and of the displayed +cones.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.choropl +eth.colorbar.Tickformatstop instances or dicts +with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.choropleth.colorbar.tickformatstopdefaults), +sets the default property values to use for +elements of choropleth.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.choropleth.colorba +r.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +choropleth.colorbar.title.font instead. Sets +this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +choropleth.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property featureidkey¶

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¶

Returns: +
Return type: str
+

+ +

+property geojson¶

The ‘geojson’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘location+z’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property locationmode¶

The ‘locationmode’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘ISO-3’, ‘USA-states’, ‘country names’, ‘geojson-id’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property locations¶

Sets the coordinates via location IDs or names. See +locationmode for more info.

The ‘locations’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property locationssrc¶

Sets the source reference on Chart Studio Cloud for locations +.

The ‘locationssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.choropleth.marker. +Line instance or dict with compatible +properties
+
+
opacity
Sets the opacity of the locations.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choropleth.selecte +d.Marker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Stream
+

+ +

+property text¶

Sets the text elements associated with each location.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.choropleth.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choropleth.unselec +ted.Marker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choropleth.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the color values.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

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, legendgroup=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property autocolorscale¶

The ‘autocolorscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property below¶

The ‘below’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property coloraxis¶

Returns: +
Return type: str
+

+ +

+property colorbar¶

The ‘colorbar’ property is an instance of ColorBar +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.ColorBar
+
A dict of string/value properties that will be passed +to the ColorBar constructor
+
Supported dict properties:
+
+
+
bgcolor
Sets the color of padded area.
+
+
bordercolor
Sets the axis line color.
+
+
borderwidth
Sets the width (in px) or the border enclosing +this color bar.
+
+
dtick
Sets the step in-between ticks on this axis. +Use with tick0. Must be a positive number, or +special strings available to “log” and “date” +axes. If the axis type is “log”, then ticks +are set every 10^(n*dtick) where n is the tick +number. For example, to set a tick mark at 1, +10, 100, 1000, … set dtick to 1. To set tick +marks at 1, 100, 10000, … set dtick to 2. To +set tick marks at 1, 5, 25, 125, 625, 3125, … +set dtick to log_10(5), or 0.69897000433. “log” +has several special values; “L<f>”, where f +is a positive number, gives ticks linearly +spaced in value (but not position). For example +tick0 = 0.1, dtick = “L0.5” will put ticks +at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 +plus small digits between, use “D1” (all +digits) or “D2” (only 2 and 5). tick0 is +ignored for “D1” and “D2”. If the axis type +is “date”, then you must convert the time to +milliseconds. For example, to set the interval +between ticks to one day, set dtick to +86400000.0. “date” also has special values +“M<n>” gives ticks spaced by a number of +months. n must be a positive integer. To set +ticks on the 15th of every third month, set +tick0 to “2000-01-15” and dtick to “M3”. To +set ticks every 4 years, set dtick to “M48”
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
len
Sets the length of the color bar This measure +excludes the padding of both ends. That is, the +color bar length is this length minus the +padding on both ends.
+
+
lenmode
Determines whether this color bar’s length +(i.e. the measure in the color variation +direction) is set in units of plot “fraction” +or in *pixels. Use len to set the value.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
outlinecolor
Sets the axis line color.
+
+
outlinewidth
Sets the width (in px) of the axis line.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showticklabels
Determines whether or not the tick labels are +drawn.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
thickness
Sets the thickness of the color bar This +measure excludes the size of the padding, ticks +and labels.
+
+
thicknessmode
Determines whether this color bar’s thickness +(i.e. the measure in the constant color +direction) is set in units of plot “fraction” +or in “pixels”. Use thickness to set the +value.
+
+
tick0
Sets the placement of the first tick on this +axis. Use with dtick. If the axis type is +“log”, then you must take the log of your +starting tick (e.g. to set the starting tick to +100, set the tick0 to 2) except when +dtick`=*L<f>* (see `dtick for more info). If +the axis type is “date”, it should be a date +string, like date data. If the axis type is +“category”, it should be a number, using the +scale where each category is assigned a serial +number from zero in the order it appears.
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickcolor
Sets the tick color.
+
+
tickfont
Sets the color bar’s tick label font
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format +We add one item to d3’s date formatter: “%{n}f” +for fractional seconds with n digits. For +example, 2016-10-13 09:15:23.456 with +tickformat “%H~%M~%S.%2f” would display +“09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.choropl +ethmapbox.colorbar.Tickformatstop instances or +dicts with compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.choroplethmapbox.colorbar.tickformatstopdefau +lts), sets the default property values to use +for elements of +choroplethmapbox.colorbar.tickformatstops
+
+
ticklen
Sets the tick length (in px).
+
+
tickmode
Sets the tick mode for this axis. If “auto”, +the number of ticks is set via nticks. If +“linear”, the placement of the ticks is +determined by a starting position tick0 and a +tick step dtick (“linear” is the default +value if tick0 and dtick are provided). If +“array”, the placement of the ticks is set via +tickvals and the tick text is ticktext. +(“array” is the default value if tickvals is +provided).
+
+
tickprefix
Sets a tick label prefix.
+
+
ticks
Determines whether ticks are drawn or not. If +“”, this axis’ ticks are not drawn. If +“outside” (“inside”), this axis’ are drawn +outside (inside) the axis lines.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
tickwidth
Sets the tick width (in px).
+
+
title
plotly.graph_objects.choroplethmapbox.c +olorbar.Title instance or dict with compatible +properties
+
+
titlefont
Deprecated: Please use +choroplethmapbox.colorbar.title.font instead. +Sets this color bar’s title font. Note that the +title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleside
Deprecated: Please use +choroplethmapbox.colorbar.title.side instead. +Determines the location of color bar’s title +with respect to the color bar. Note that the +title’s location used to be set by the now +deprecated titleside attribute.
+
+
x
Sets the x position of the color bar (in plot +fraction).
+
+
xanchor
Sets this color bar’s horizontal position +anchor. This anchor binds the x position to +the “left”, “center” or “right” of the color +bar.
+
+
xpad
Sets the amount of padding (in px) along the x +direction.
+
+
y
Sets the y position of the color bar (in plot +fraction).
+
+
yanchor
Sets this color bar’s vertical position anchor +This anchor binds the y position to the +“top”, “middle” or “bottom” of the color bar.
+
+
ypad
Sets the amount of padding (in px) along the y +direction.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.ColorBar
+

+ +

+property colorscale¶

Sets the colorscale. The colorscale must be an array containing +arrays mapping a normalized value to an rgb, rgba, hex, hsl, +hsv, or named color string. At minimum, a mapping for the +lowest (0) and highest (1) values are required. For example, +[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the +bounds of the colorscale in color space, use`zmin` and zmax. +Alternatively, colorscale may be a palette name string of the +following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi +ridis,Cividis.

The ‘colorscale’ property is a colorscale and may be +specified as:

+
+
A list of colors that will be spaced evenly to create the colorscale. +Many predefined colorscale lists are included in the sequential, diverging, +and cyclical modules in the plotly.colors package.
+
A list of 2-element lists where the first element is the +normalized color level value (starting at 0 and ending at 1), +and the second item is a valid color string. +(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
+
+
One of the following named colorscales:
+
[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, +‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, +‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, +‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, +‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, +‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, +‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, +‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, +‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, +‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, +‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, +‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, +‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
+
+
+
+
+
Appending ‘_r’ to a named colorscale reverses it.
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property featureidkey¶

Sets the key in GeoJSON features which is used as id to match +the items included in the locations array. 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¶

The ‘geojson’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘location’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘location+z’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variable properties Anything contained in tag <extra> is +displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary box +completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property locations¶

Sets which features found in “geojson” to plot using their +feature id field.

The ‘locations’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property locationssrc¶

Sets the source reference on Chart Studio Cloud for locations +.

The ‘locationssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
line
plotly.graph_objects.choroplethmapbox.m +arker.Line instance or dict with compatible +properties
+
+
opacity
Sets the opacity of the locations.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property reversescale¶

Reverses the color mapping if true. If true, zmin will +correspond to the last color in the array and zmax will +correspond to the first color.

The ‘reversescale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choroplethmapbox.s +elected.Marker instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property showscale¶

Determines whether or not a colorbar is displayed for this +trace.

The ‘showscale’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

Sets the text elements associated with each location.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.choroplethmapbox.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.choroplethmapbox.u +nselected.Marker instance or dict with +compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.choroplethmapbox.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property z¶

Sets the color values.

The ‘z’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property zauto¶

The ‘zauto’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property zmax¶

Sets the upper bound of the color domain. Value should have the +same units as in z and if set, zmin must be set as well.

The ‘zmax’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmid¶

Sets the mid-point of the color domain by scaling zmin and/or +zmax to be equidistant to this point. Value should have the +same units as in z. Has no effect when zauto is false.

The ‘zmid’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zmin¶

Sets the lower bound of the color domain. Value should have the +same units as in z and if set, zmax must be set as well.

The ‘zmin’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property zsrc¶

Sets the source reference on Chart Studio Cloud for z .

The ‘zsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property a¶

An array containing values of the first parameter value

The ‘a’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property a0¶

Alternate to a. Builds a linear space of a coordinates. Use +with da where a0 is the starting coordinate and da the +step.

The ‘a0’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property aaxis¶

The ‘aaxis’ property is an instance of Aaxis +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Aaxis
+
A dict of string/value properties that will be passed +to the Aaxis constructor
+
Supported dict properties:
+
+
+
arraydtick
The stride between grid lines along the axis
+
+
arraytick0
The starting index of grid lines along the axis
+
+
autorange
Determines whether or not the range of this +axis is computed in relation to the input data. +See rangemode for more info. If range is +provided, then autorange is set to False.
+
+
categoryarray
Sets the order in which categories on this axis +appear. Only has an effect if categoryorder +is set to “array”. Used with categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the case of +categorical variables. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray.
+
+
+
cheatertype
+
+
color
Sets default for all colors associated with +this axis all at once: line, font, tick, and +grid colors. Grid color is lightened by +blending this with the plot background +Individual pieces can override this.
+
+
dtick
The stride between grid lines along the axis
+
+
endline
Determines whether or not a line is drawn at +along the final value of this axis. If True, +the end line is drawn on top of the grid lines.
+
+
endlinecolor
Sets the line color of the end line.
+
+
endlinewidth
Sets the width (in px) of the end line.
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
fixedrange
Determines whether or not this axis is zoom- +able. If true, then zoom is disabled.
+
+
gridcolor
Sets the axis line color.
+
+
gridwidth
Sets the width (in px) of the axis line.
+
+
labelpadding
Extra padding between label and the axis
+
+
labelprefix
Sets a axis label prefix.
+
+
labelsuffix
Sets a axis label suffix.
+
+
linecolor
Sets the axis line color.
+
+
linewidth
Sets the width (in px) of the axis line.
+
+
minorgridcolor
Sets the color of the grid lines.
+
+
minorgridcount
Sets the number of minor grid ticks per major +grid tick
+
+
minorgridwidth
Sets the width (in px) of the grid lines.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
range
Sets the range of this axis. If the axis type +is “log”, then you must take the log of your +desired range (e.g. to set the range from 1 to +100, set the range from 0 to 2). If the axis +type is “date”, it should be date strings, +like date data, though Date objects and unix +milliseconds will be accepted and converted to +strings. If the axis type is “category”, it +should be numbers, using the scale where each +category is assigned a serial number from zero +in the order it appears.
+
+
rangemode
If “normal”, the range is computed in relation +to the extrema of the input data. If *tozero*`, +the range extends to 0, regardless of the input +data If “nonnegative”, the range is non- +negative, regardless of the input data.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showgrid
Determines whether or not grid lines are drawn. +If True, the grid lines are drawn at every tick +mark.
+
+
showline
Determines whether or not a line bounding this +axis is drawn.
+
+
showticklabels
Determines whether axis labels are drawn on the +low side, the high side, both, or neither side +of the axis.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
+
smoothing
+
+
startline
Determines whether or not a line is drawn at +along the starting value of this axis. If True, +the start line is drawn on top of the grid +lines.
+
+
startlinecolor
Sets the line color of the start line.
+
+
startlinewidth
Sets the width (in px) of the start line.
+
+
tick0
The starting index of grid lines along the axis
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickfont
Sets the tick font.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: We add one item to d3’s +date formatter: “%{n}f” for fractional seconds +with n digits. For example, 2016-10-13 +09:15:23.456 with tickformat “%H~%M~%S.%2f” +would display “09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.carpet. +aaxis.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.carpet.aaxis.tickformatstopdefaults), sets +the default property values to use for elements +of carpet.aaxis.tickformatstops
+
+
+
tickmode
+
+
tickprefix
Sets a tick label prefix.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
title
:class:`plotly.graph_objects.carpet.aaxis.Title +` instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use carpet.aaxis.title.font +instead. Sets this axis’ title font. Note that +the title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleoffset
Deprecated: Please use +carpet.aaxis.title.offset instead. An +additional amount by which to offset the title +from the tick labels, given in pixels. Note +that this used to be set by the now deprecated +titleoffset attribute.
+
+
type
Sets the axis type. By default, plotly attempts +to determined the axis type by looking into the +data of the traces that referenced the axis in +question.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Aaxis
+

+ +

+property asrc¶

Sets the source reference on Chart Studio Cloud for a .

The ‘asrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property b¶

A two dimensional array of y coordinates at each carpet point.

The ‘b’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property b0¶

Alternate to b. Builds a linear space of a coordinates. Use +with db where b0 is the starting coordinate and db the +step.

The ‘b0’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property baxis¶

The ‘baxis’ property is an instance of Baxis +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Baxis
+
A dict of string/value properties that will be passed +to the Baxis constructor
+
Supported dict properties:
+
+
+
arraydtick
The stride between grid lines along the axis
+
+
arraytick0
The starting index of grid lines along the axis
+
+
autorange
Determines whether or not the range of this +axis is computed in relation to the input data. +See rangemode for more info. If range is +provided, then autorange is set to False.
+
+
categoryarray
Sets the order in which categories on this axis +appear. Only has an effect if categoryorder +is set to “array”. Used with categoryorder.
+
+
categoryarraysrc
Sets the source reference on Chart Studio Cloud +for categoryarray .
+
+
categoryorder
Specifies the ordering logic for the case of +categorical variables. By default, plotly uses +“trace”, which specifies the order that is +present in the data supplied. Set +categoryorder to category ascending or +category descending if order should be +determined by the alphanumerical order of the +category names. Set categoryorder to “array” +to derive the ordering from the attribute +categoryarray. If a category is not found in +the categoryarray array, the sorting behavior +for that attribute will be identical to the +“trace” mode. The unspecified categories will +follow the categories in categoryarray.
+
+
+
cheatertype
+
+
color
Sets default for all colors associated with +this axis all at once: line, font, tick, and +grid colors. Grid color is lightened by +blending this with the plot background +Individual pieces can override this.
+
+
dtick
The stride between grid lines along the axis
+
+
endline
Determines whether or not a line is drawn at +along the final value of this axis. If True, +the end line is drawn on top of the grid lines.
+
+
endlinecolor
Sets the line color of the end line.
+
+
endlinewidth
Sets the width (in px) of the end line.
+
+
exponentformat
Determines a formatting rule for the tick +exponents. For example, consider the number +1,000,000,000. If “none”, it appears as +1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If +“power”, 1x10^9 (with 9 in a super script). If +“SI”, 1G. If “B”, 1B.
+
+
fixedrange
Determines whether or not this axis is zoom- +able. If true, then zoom is disabled.
+
+
gridcolor
Sets the axis line color.
+
+
gridwidth
Sets the width (in px) of the axis line.
+
+
labelpadding
Extra padding between label and the axis
+
+
labelprefix
Sets a axis label prefix.
+
+
labelsuffix
Sets a axis label suffix.
+
+
linecolor
Sets the axis line color.
+
+
linewidth
Sets the width (in px) of the axis line.
+
+
minorgridcolor
Sets the color of the grid lines.
+
+
minorgridcount
Sets the number of minor grid ticks per major +grid tick
+
+
minorgridwidth
Sets the width (in px) of the grid lines.
+
+
nticks
Specifies the maximum number of ticks for the +particular axis. The actual number of ticks +will be chosen automatically to be less than or +equal to nticks. Has an effect only if +tickmode is set to “auto”.
+
+
range
Sets the range of this axis. If the axis type +is “log”, then you must take the log of your +desired range (e.g. to set the range from 1 to +100, set the range from 0 to 2). If the axis +type is “date”, it should be date strings, +like date data, though Date objects and unix +milliseconds will be accepted and converted to +strings. If the axis type is “category”, it +should be numbers, using the scale where each +category is assigned a serial number from zero +in the order it appears.
+
+
rangemode
If “normal”, the range is computed in relation +to the extrema of the input data. If *tozero*`, +the range extends to 0, regardless of the input +data If “nonnegative”, the range is non- +negative, regardless of the input data.
+
+
separatethousands
If “true”, even 4-digit integers are separated
+
+
showexponent
If “all”, all exponents are shown besides their +significands. If “first”, only the exponent of +the first tick is shown. If “last”, only the +exponent of the last tick is shown. If “none”, +no exponents appear.
+
+
showgrid
Determines whether or not grid lines are drawn. +If True, the grid lines are drawn at every tick +mark.
+
+
showline
Determines whether or not a line bounding this +axis is drawn.
+
+
showticklabels
Determines whether axis labels are drawn on the +low side, the high side, both, or neither side +of the axis.
+
+
showtickprefix
If “all”, all tick labels are displayed with a +prefix. If “first”, only the first tick is +displayed with a prefix. If “last”, only the +last tick is displayed with a suffix. If +“none”, tick prefixes are hidden.
+
+
showticksuffix
Same as showtickprefix but for tick suffixes.
+
+
+
smoothing
+
+
startline
Determines whether or not a line is drawn at +along the starting value of this axis. If True, +the start line is drawn on top of the grid +lines.
+
+
startlinecolor
Sets the line color of the start line.
+
+
startlinewidth
Sets the width (in px) of the start line.
+
+
tick0
The starting index of grid lines along the axis
+
+
tickangle
Sets the angle of the tick labels with respect +to the horizontal. For example, a tickangle +of -90 draws the tick labels vertically.
+
+
tickfont
Sets the tick font.
+
+
tickformat
Sets the tick label formatting rule using d3 +formatting mini-languages which are very +similar to those in Python. For numbers, see: +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format +And for dates see: We add one item to d3’s +date formatter: “%{n}f” for fractional seconds +with n digits. For example, 2016-10-13 +09:15:23.456 with tickformat “%H~%M~%S.%2f” +would display “09~15~23.46”
+
+
tickformatstops
A tuple of plotly.graph_objects.carpet. +baxis.Tickformatstop instances or dicts with +compatible properties
+
+
tickformatstopdefaults
When used in a template (as layout.template.dat +a.carpet.baxis.tickformatstopdefaults), sets +the default property values to use for elements +of carpet.baxis.tickformatstops
+
+
+
tickmode
+
+
tickprefix
Sets a tick label prefix.
+
+
ticksuffix
Sets a tick label suffix.
+
+
ticktext
Sets the text displayed at the ticks position +via tickvals. Only has an effect if +tickmode is set to “array”. Used with +tickvals.
+
+
ticktextsrc
Sets the source reference on Chart Studio Cloud +for ticktext .
+
+
tickvals
Sets the values at which ticks on this axis +appear. Only has an effect if tickmode is set +to “array”. Used with ticktext.
+
+
tickvalssrc
Sets the source reference on Chart Studio Cloud +for tickvals .
+
+
title
:class:`plotly.graph_objects.carpet.baxis.Title +` instance or dict with compatible properties
+
+
titlefont
Deprecated: Please use carpet.baxis.title.font +instead. Sets this axis’ title font. Note that +the title’s font used to be set by the now +deprecated titlefont attribute.
+
+
titleoffset
Deprecated: Please use +carpet.baxis.title.offset instead. An +additional amount by which to offset the title +from the tick labels, given in pixels. Note +that this used to be set by the now deprecated +titleoffset attribute.
+
+
type
Sets the axis type. By default, plotly attempts +to determined the axis type by looking into the +data of the traces that referenced the axis in +question.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Baxis
+

+ +

+property bsrc¶

Sets the source reference on Chart Studio Cloud for b .

The ‘bsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property carpet¶

An identifier for this carpet, so that scattercarpet and +contourcarpet traces can specify a carpet plot on which they +lie

The ‘carpet’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property cheaterslope¶

The shift applied to each successive row of data in creating a +cheater plot. Only used if x is been ommitted.

The ‘cheaterslope’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property color¶

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
+
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property da¶

Sets the a coordinate step. See a0 for more info.

The ‘da’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property db¶

Sets the b coordinate step. See b0 for more info.

The ‘db’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property font¶

The default font used for axis & tick labels on this carpet

The ‘font’ property is an instance of Font +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Font
+
A dict of string/value properties that will be passed +to the Font constructor
+
Supported dict properties:
+
+
color
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
+
size
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Font
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.carpet.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.carpet.Stream
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property x¶

A two dimensional array of x coordinates at each carpet point. +If ommitted, the plot is a cheater plot and the xaxis is hidden +by default.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

A two dimensional array of y coordinates at each carpet point.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property close¶

Sets the close values.

The ‘close’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property closesrc¶

Sets the source reference on Chart Studio Cloud for close .

The ‘closesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property decreasing¶

The ‘decreasing’ property is an instance of Decreasing +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Decreasing
+
A dict of string/value properties that will be passed +to the Decreasing constructor
+
Supported dict properties:
+
+
+
fillcolor
Sets the fill color. Defaults to a half- +transparent variant of the line color, marker +color, or marker line color, whichever is +available.
+
+
line
plotly.graph_objects.candlestick.decrea +sing.Line instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Decreasing
+

+ +

+property high¶

Sets the high values.

The ‘high’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property highsrc¶

Sets the source reference on Chart Studio Cloud for high .

The ‘highsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
split
Show hover information (open, close, high, low) +in separate labels.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Hoverlabel
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property increasing¶

The ‘increasing’ property is an instance of Increasing +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Increasing
+
A dict of string/value properties that will be passed +to the Increasing constructor
+
Supported dict properties:
+
+
+
fillcolor
Sets the fill color. Defaults to a half- +transparent variant of the line color, marker +color, or marker line color, whichever is +available.
+
+
line
plotly.graph_objects.candlestick.increa +sing.Line instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Increasing
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
width
Sets the width (in px) of line bounding the +box(es). Note that this style setting can also +be set per direction via +increasing.line.width and +decreasing.line.width.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Line
+

+ +

+property low¶

Sets the low values.

The ‘low’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property lowsrc¶

Sets the source reference on Chart Studio Cloud for low .

The ‘lowsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property open¶

Sets the open values.

The ‘open’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property opensrc¶

Sets the source reference on Chart Studio Cloud for open .

The ‘opensrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.candlestick.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.candlestick.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property whiskerwidth¶

Sets the width of the whiskers relative to the box’ width. For +example, with 1, the whiskers are as wide as the box(es).

The ‘whiskerwidth’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property x¶

Sets the x coordinates. If absent, linear coordinate will be +generated.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property boxmean¶

The ‘boxmean’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, ‘sd’, False]
+
+
+

Returns: +
Return type: Any
+

+ +

+property boxpoints¶

If “outliers”, only the sample points lying outside the +whiskers are shown If “suspectedoutliers”, the outlier points +are shown and points either less than 4*Q1-3*Q3 or greater than +4*Q3-3*Q1 are highlighted (see outliercolor) If “all”, all +sample points are shown If False, only the box(es) are shown +with no sample points Defaults to “suspectedoutliers” when +marker.outliercolor or marker.line.outliercolor is set. +Defaults to “all” under the q1/median/q3 signature. Otherwise +defaults to “outliers”.

The ‘boxpoints’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘all’, ‘outliers’, ‘suspectedoutliers’, False]
+
+
+

Returns: +
Return type: Any
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dx¶

Sets the x coordinate step for multi-box traces set using +q1/median/q3.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dy¶

Sets the y coordinate step for multi-box traces set using +q1/median/q3.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property fillcolor¶

Sets the fill color. Defaults to a half-transparent variant of +the line color, marker color, or marker line color, whichever +is available.

The ‘fillcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
+
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, +beige, bisque, black, blanchedalmond, blue, +blueviolet, brown, burlywood, cadetblue, +chartreuse, chocolate, coral, cornflowerblue, +cornsilk, crimson, cyan, darkblue, darkcyan, +darkgoldenrod, darkgray, darkgrey, darkgreen, +darkkhaki, darkmagenta, darkolivegreen, darkorange, +darkorchid, darkred, darksalmon, darkseagreen, +darkslateblue, darkslategray, darkslategrey, +darkturquoise, darkviolet, deeppink, deepskyblue, +dimgray, dimgrey, dodgerblue, firebrick, +floralwhite, forestgreen, fuchsia, gainsboro, +ghostwhite, gold, goldenrod, gray, grey, green, +greenyellow, honeydew, hotpink, indianred, indigo, +ivory, khaki, lavender, lavenderblush, lawngreen, +lemonchiffon, lightblue, lightcoral, lightcyan, +lightgoldenrodyellow, lightgray, lightgrey, +lightgreen, lightpink, lightsalmon, lightseagreen, +lightskyblue, lightslategray, lightslategrey, +lightsteelblue, lightyellow, lime, limegreen, +linen, magenta, maroon, mediumaquamarine, +mediumblue, mediumorchid, mediumpurple, +mediumseagreen, mediumslateblue, mediumspringgreen, +mediumturquoise, mediumvioletred, midnightblue, +mintcream, mistyrose, moccasin, navajowhite, navy, +oldlace, olive, olivedrab, orange, orangered, +orchid, palegoldenrod, palegreen, paleturquoise, +palevioletred, papayawhip, peachpuff, peru, pink, +plum, powderblue, purple, red, rosybrown, +royalblue, rebeccapurple, saddlebrown, salmon, +sandybrown, seagreen, seashell, sienna, silver, +skyblue, slateblue, slategray, slategrey, snow, +springgreen, steelblue, tan, teal, thistle, tomato, +turquoise, violet, wheat, white, whitesmoke, +yellow, yellowgreen
+
+
+

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Hoverlabel
+

+ +

+property hoveron¶

Do the hover effects highlight individual boxes or sample +points or both?

The ‘hoveron’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘boxes’, ‘points’] joined with ‘+’ characters +(e.g. ‘boxes+points’)
+
+

Returns: +
Return type: Any
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#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¶

The ‘jitter’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property line¶

The ‘line’ property is an instance of Line +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Line
+
A dict of string/value properties that will be passed +to the Line constructor
+
Supported dict properties:
+
+
+
color
Sets the color of line bounding the box(es).
+
+
width
Sets the width (in px) of line bounding the +box(es).
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Line
+

+ +

+property lowerfence¶

The ‘lowerfence’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property lowerfencesrc¶

Sets the source reference on Chart Studio Cloud for lowerfence +.

The ‘lowerfencesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
line
plotly.graph_objects.box.marker.Line +instance or dict with compatible properties
+
+
opacity
Sets the marker opacity.
+
+
outliercolor
Sets the color of the outlier sample points.
+
+
size
Sets the marker size (in px).
+
+
symbol
Sets the marker symbol type. Adding 100 is +equivalent to appending “-open” to a symbol +name. Adding 200 is equivalent to appending +“-dot” to a symbol name. Adding 300 is +equivalent to appending “-open-dot” or “dot- +open” to a symbol name.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Marker
+

+ +

+property mean¶

The ‘mean’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property meansrc¶

Sets the source reference on Chart Studio Cloud for mean .

The ‘meansrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property median¶

Sets the median values. There should be as many items as the +number of boxes desired.

The ‘median’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property mediansrc¶

Sets the source reference on Chart Studio Cloud for median .

The ‘mediansrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

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¶

The ‘notched’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property notchspan¶

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¶

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¶

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¶

The ‘sd’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property sdsrc¶

Sets the source reference on Chart Studio Cloud for sd .

The ‘sdsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.box.selected.Marke +r instance or dict with compatible properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Stream
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.box.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.box.unselected.Mar +ker instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.box.Unselected
+

+ +

+property upperfence¶

The ‘upperfence’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property upperfencesrc¶

Sets the source reference on Chart Studio Cloud for upperfence +.

The ‘upperfencesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property whiskerwidth¶

Sets the width of the whiskers relative to the box’ width. For +example, with 1, the whiskers are as wide as the box(es).

The ‘whiskerwidth’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property width¶

Sets the width of the box in data coordinate If 0 (default +value) the width is automatically selected based on the +positions of other box traces in the same subplot.

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns: +
Return type: int|float
+

+ +

+property x¶

Sets the x sample data or coordinates. See overview for more +info.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Sets the x coordinate for single-box traces or the starting +coordinate for multi-box traces set using q1/median/q3. See +overview for more info.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y sample data or coordinates. See overview for more +info.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Sets the y coordinate for single-box traces or the starting +coordinate for multi-box traces set using q1/median/q3. See +overview for more info.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, t=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property alignmentgroup¶

Set several traces linked to the same position axis or matching +axes to the same alignmentgroup. This controls whether bars +compute their positional range dependently or independently.

The ‘alignmentgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property base¶

Sets where the bar base is drawn (in position axis units). In +“stack” or “relative” barmode, traces that set “base” will be +excluded and drawn in “overlay” mode instead.

The ‘base’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property basesrc¶

Sets the source reference on Chart Studio Cloud for base .

The ‘basesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property cliponaxis¶

Determines whether the text nodes are clipped about the subplot +axes. To show the text nodes above axis lines and tick labels, +make sure to set xaxis.layer and yaxis.layer to below +traces.

The ‘cliponaxis’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property constraintext¶

Constrain the size of text inside or outside a bar to be no +larger than the bar itself.

The ‘constraintext’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘inside’, ‘outside’, ‘both’, ‘none’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dx¶

Sets the x coordinate step. See x0 for more info.

The ‘dx’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dy¶

Sets the y coordinate step. See y0 for more info.

The ‘dy’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property error_x¶

The ‘error_x’ property is an instance of ErrorX +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.ErrorX
+
A dict of string/value properties that will be passed +to the ErrorX constructor
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
+
copy_ystyle
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.ErrorX
+

+ +

+property error_y¶

The ‘error_y’ property is an instance of ErrorY +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.ErrorY
+
A dict of string/value properties that will be passed +to the ErrorY constructor
+
Supported dict properties:
+
+
+
array
Sets the data corresponding the length of each +error bar. Values are plotted relative to the +underlying data.
+
+
arrayminus
Sets the data corresponding the length of each +error bar in the bottom (left) direction for +vertical (horizontal) bars Values are plotted +relative to the underlying data.
+
+
arrayminussrc
Sets the source reference on Chart Studio Cloud +for arrayminus .
+
+
arraysrc
Sets the source reference on Chart Studio Cloud +for array .
+
+
color
Sets the stoke color of the error bars.
+
+
symmetric
Determines whether or not the error bars have +the same length in both direction (top/bottom +for vertical bars, left/right for horizontal +bars.
+
+
thickness
Sets the thickness (in px) of the error bars.
+
+
+
traceref
+
tracerefminus
+
+
type
Determines the rule used to generate the error +bars. If *constant`, the bar lengths are of a +constant value. Set this constant in value. +If “percent”, the bar lengths correspond to a +percentage of underlying data. Set this +percentage in value. If “sqrt”, the bar +lengths correspond to the sqaure of the +underlying data. If “data”, the bar lengths are +set with data set array.
+
+
value
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars.
+
+
valueminus
Sets the value of either the percentage (if +type is set to “percent”) or the constant (if +type is set to “constant”) corresponding to +the lengths of the error bars in the bottom +(left) direction for vertical (horizontal) bars
+
+
visible
Determines whether or not this set of error +bars is visible.
+
+
width
Sets the width (in px) of the cross-bar at both +ends of the error bars.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.ErrorY
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +variables value and label. Anything contained in tag +<extra> is displayed in the secondary box, for example +“<extra>{fullData.name}</extra>”. To hide the secondary box +completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property insidetextanchor¶

Determines if texts are kept at center or start/end points in +textposition “inside” mode.

The ‘insidetextanchor’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘end’, ‘middle’, ‘start’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property insidetextfont¶

Sets the font used for text lying inside the bar.

The ‘insidetextfont’ property is an instance of Insidetextfont +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Insidetextfont
+
A dict of string/value properties that will be passed +to the Insidetextfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Insidetextfont
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.bar.marker.ColorBa +r instance or dict with compatible properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.bar.marker.Line +instance or dict with compatible properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

Shifts the position where the bar is drawn (in position axis +units). In “group” barmode, traces that set “offset” will be +excluded and drawn in “overlay” mode instead.

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property offsetgroup¶

Set several traces linked to the same position axis or matching +axes to the same offsetgroup where bars of the same position +coordinate will line up.

The ‘offsetgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offsetsrc¶

Sets the source reference on Chart Studio Cloud for offset .

The ‘offsetsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property orientation¶

Sets the orientation of the bars. With “v” (“h”), the value of +the each bar spans along the vertical (horizontal).

The ‘orientation’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘v’, ‘h’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property outsidetextfont¶

Sets the font used for text lying outside the bar.

The ‘outsidetextfont’ property is an instance of Outsidetextfont +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Outsidetextfont
+
A dict of string/value properties that will be passed +to the Outsidetextfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Outsidetextfont
+

+ +

+property r¶

r coordinates in scatter traces are deprecated!Please switch to +the “scatterpolar” trace type.Sets the radial coordinatesfor +legacy polar chart only.

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.bar.selected.Marke +r instance or dict with compatible properties
+
+
textfont
plotly.graph_objects.bar.selected.Textf +ont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Stream
+

+ +

+property t¶

t coordinates in scatter traces are deprecated!Please switch to +the “scatterpolar” trace type.Sets the angular coordinatesfor +legacy polar chart only.

The ‘t’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property text¶

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¶

Returns: +
Return type: int|float
+

+ +

+property textfont¶

Sets the font used for text.

The ‘textfont’ property is an instance of Textfont +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Textfont
+
A dict of string/value properties that will be passed +to the Textfont constructor
+
Supported dict properties:
+
+
color
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
family
HTML font family - the typeface that will be +applied by the web browser. The web browser +will only be able to apply a font if it is +available on the system which it operates. +Provide multiple font families, separated by +commas, to indicate the preference in which to +apply fonts if they aren’t available on the +system. The Chart Studio Cloud (at +https://chart-studio.plotly.com or on-premise) +generates images on a server, where only a +select number of fonts are installed and +supported. These include “Arial”, “Balto”, +“Courier New”, “Droid Sans”,, “Droid Serif”, +“Droid Sans Mono”, “Gravitas One”, “Old +Standard TT”, “Open Sans”, “Overpass”, “PT Sans +Narrow”, “Raleway”, “Times New Roman”.
+
+
familysrc
Sets the source reference on Chart Studio Cloud +for family .
+
+
+
size
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Textfont
+

+ +

+property textposition¶

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¶

The ‘texttemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property texttemplatesrc¶

Sets the source reference on Chart Studio Cloud for +texttemplate .

The ‘texttemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.bar.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.bar.unselected.Mar +ker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.bar.unselected.Tex +tfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.bar.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property width¶

Sets the bar width (in position axis units).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property widthsrc¶

Sets the source reference on Chart Studio Cloud for width .

The ‘widthsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property x¶

Sets the x coordinates.

The ‘x’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property x0¶

Alternate to x. Builds a linear space of x coordinates. Use +with dx where x0 is the starting coordinate and dx the +step.

The ‘x0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property xaxis¶

Returns: +
Return type: str
+

+ +

+property xcalendar¶

Sets the calendar system to use with x date data.

The ‘xcalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property xsrc¶

Sets the source reference on Chart Studio Cloud for x .

The ‘xsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property y¶

Sets the y coordinates.

The ‘y’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property y0¶

Alternate to y. Builds a linear space of y coordinates. Use +with dy where y0 is the starting coordinate and dy the +step.

The ‘y0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property yaxis¶

Returns: +
Return type: str
+

+ +

+property ycalendar¶

Sets the calendar system to use with y date data.

The ‘ycalendar’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘gregorian’, ‘chinese’, ‘coptic’, ‘discworld’, +‘ethiopian’, ‘hebrew’, ‘islamic’, ‘julian’, ‘mayan’, +‘nanakshahi’, ‘nepali’, ‘persian’, ‘jalali’, ‘taiwan’, +‘thai’, ‘ummalqura’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property ysrc¶

Sets the source reference on Chart Studio Cloud for y .

The ‘ysrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.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, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property base¶

Sets where the bar base is drawn (in radial axis units). In +“stack” barmode, traces that set “base” will be excluded and +drawn in “overlay” mode instead.

The ‘base’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property basesrc¶

Sets the source reference on Chart Studio Cloud for base .

The ‘basesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property dr¶

Sets the r coordinate step.

The ‘dr’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property dtheta¶

Sets the theta coordinate step. By default, the dtheta step +equals the subplot’s period divided by the length of the r +coordinates.

The ‘dtheta’ property is a number and may be specified as:

An int or float

Returns: +
Return type: int|float
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘r’, ‘theta’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘r+theta’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Hoverlabel
+

+ +

+property hovertemplate¶

Template string used for rendering the information that appear +on hover box. Note that this will override hoverinfo. +Variables are inserted using %{variable}, for example “y: +%{y}”. Numbers are formatted using d3-format’s syntax +%{variable:d3-format}, for example “Price: %{y:$.2f}”. +https://github.com/d3/d3-3.x-api- +reference/blob/master/Formatting.md#d3_format for details on +the formatting syntax. Dates are formatted using d3-time- +format’s syntax %{variable|d3-time-format}, for example “Day: +%{2019-01-01|%A}”. https://github.com/d3/d3-3.x-api- +reference/blob/master/Time-Formatting.md#format for details on +the date formatting syntax. The variables available in +hovertemplate are the ones emitted as event data described at +this link https://plotly.com/javascript/plotlyjs-events/#event- +data. Additionally, every attributes that can be specified per- +point (the ones that are arrayOk: true) are available. +Anything contained in tag <extra> is displayed in the +secondary box, for example “<extra>{fullData.name}</extra>”. To +hide the secondary box completely, use an empty tag +<extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertemplatesrc¶

Sets the source reference on Chart Studio Cloud for +hovertemplate .

The ‘hovertemplatesrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hovertext¶

Same as text.

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property hovertextsrc¶

Sets the source reference on Chart Studio Cloud for hovertext +.

The ‘hovertextsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
autocolorscale
Determines whether the colorscale is a default +palette (autocolorscale: true) or the palette +determined by marker.colorscale. Has an +effect only if in marker.color`is set to a +numerical array. In case `colorscale is +unspecified or autocolorscale is true, the +default palette will be chosen according to +whether numbers in the color array are all +positive, all negative or mixed.
+
+
cauto
Determines whether or not the color domain is +computed with respect to the input data (here +in marker.color) or the bounds set in +marker.cmin and marker.cmax Has an effect +only if in marker.color`is set to a numerical +array. Defaults to `false when marker.cmin +and marker.cmax are set by the user.
+
+
cmax
Sets the upper bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmin must be set as well.
+
+
cmid
Sets the mid-point of the color domain by +scaling marker.cmin and/or marker.cmax to +be equidistant to this point. Has an effect +only if in marker.color`is set to a numerical +array. Value should have the same units as in +`marker.color. Has no effect when +marker.cauto is false.
+
+
cmin
Sets the lower bound of the color domain. Has +an effect only if in marker.color`is set to a +numerical array. Value should have the same +units as in `marker.color and if set, +marker.cmax must be set as well.
+
+
color
Sets themarkercolor. It accepts either a +specific color or an array of numbers that are +mapped to the colorscale relative to the max +and min values of the array or relative to +marker.cmin and marker.cmax if set.
+
+
coloraxis
Sets a reference to a shared color axis. +References to these shared color axes are +“coloraxis”, “coloraxis2”, “coloraxis3”, etc. +Settings for these shared color axes are set in +the layout, under layout.coloraxis, +layout.coloraxis2, etc. Note that multiple +color scales can be linked to the same color +axis.
+
+
colorbar
plotly.graph_objects.barpolar.marker.Co +lorBar instance or dict with compatible +properties
+
+
colorscale
Sets the colorscale. Has an effect only if in +marker.color`is set to a numerical array. The +colorscale must be an array containing arrays +mapping a normalized value to an rgb, rgba, +hex, hsl, hsv, or named color string. At +minimum, a mapping for the lowest (0) and +highest (1) values are required. For example, +`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. +To control the bounds of the colorscale in +color space, use`marker.cmin` and +marker.cmax. Alternatively, colorscale may +be a palette name string of the following list: +Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl +ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E +arth,Electric,Viridis,Cividis.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
line
plotly.graph_objects.barpolar.marker.Li +ne instance or dict with compatible properties
+
+
opacity
Sets the opacity of the bars.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
reversescale
Reverses the color mapping if true. Has an +effect only if in marker.color`is set to a +numerical array. If true, `marker.cmin will +correspond to the last color in the array and +marker.cmax will correspond to the first +color.
+
+
showscale
Determines whether or not a colorbar is +displayed for this trace. Has an effect only if +in `marker.color`is set to a numerical array.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property offset¶

Shifts the angular position where the bar is drawn (in +“thetatunit” units).

The ‘offset’ property is a number and may be specified as:

An int or float
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property offsetsrc¶

Sets the source reference on Chart Studio Cloud for offset .

The ‘offsetsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property r¶

Sets the radial coordinates

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property r0¶

Alternate to r. Builds a linear space of r coordinates. Use +with dr where r0 is the starting coordinate and dr the +step.

The ‘r0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property selected¶

The ‘selected’ property is an instance of Selected +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Selected
+
A dict of string/value properties that will be passed +to the Selected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.barpolar.selected. +Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.barpolar.selected. +Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Selected
+

+ +

+property selectedpoints¶

The ‘selectedpoints’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Stream
+

+ +

+property subplot¶

Returns: +
Return type: str
+

+ +

+property text¶

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: str|numpy.ndarray
+

+ +

+property textsrc¶

Sets the source reference on Chart Studio Cloud for text .

The ‘textsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property theta¶

Sets the angular coordinates

The ‘theta’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property theta0¶

Alternate to theta. Builds a linear space of theta +coordinates. Use with dtheta where theta0 is the starting +coordinate and dtheta the step.

The ‘theta0’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property thetasrc¶

Sets the source reference on Chart Studio Cloud for theta .

The ‘thetasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property thetaunit¶

Sets the unit of input “theta” values. Has an effect only when +on “linear” angular axes.

The ‘thetaunit’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[‘radians’, ‘degrees’, ‘gradians’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

The ‘uirevision’ property accepts values of any type

Returns: +
Return type: Any
+

+ +

+property unselected¶

The ‘unselected’ property is an instance of Unselected +that may be specified as:

+
+
An instance of plotly.graph_objects.barpolar.Unselected
+
A dict of string/value properties that will be passed +to the Unselected constructor
+
Supported dict properties:
+
+
+
marker
plotly.graph_objects.barpolar.unselecte +d.Marker instance or dict with compatible +properties
+
+
textfont
plotly.graph_objects.barpolar.unselecte +d.Textfont instance or dict with compatible +properties
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.barpolar.Unselected
+

+ +

+property visible¶

Determines whether or not this trace is visible. If +“legendonly”, the trace is not drawn, but can appear as a +legend item (provided that the legend itself is visible).

The ‘visible’ property is an enumeration that may be specified as:

+
One of the following enumeration values:
[True, False, ‘legendonly’]
+
+
+

Returns: +
Return type: Any
+

+ +

+property width¶

Sets the bar angular width (in “thetaunit” units).

The ‘width’ property is a number and may be specified as:

An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns: +
Return type: int|float|numpy.ndarray
+

+ +

+property widthsrc¶

Sets the source reference on Chart Studio Cloud for width .

The ‘widthsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+class plotly.graph_objects.layout.template.data.Area(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, r=None, rsrc=None, showlegend=None, stream=None, t=None, tsrc=None, uid=None, uirevision=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceType

+property customdata¶

Assigns extra data each datum. This may be useful when +listening to hover, click and selection events. Note that, +“scatter” traces also appends customdata items in the markers +DOM elements

The ‘customdata’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property customdatasrc¶

Sets the source reference on Chart Studio Cloud for customdata +.

The ‘customdatasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverinfo¶

Determines which trace information appear on hover. If none +or skip are set, no information is displayed upon hovering. +But, if none is set, click and hover events are still fired.

The ‘hoverinfo’ property is a flaglist and may be specified +as a string containing:

+
+
Any combination of [‘x’, ‘y’, ‘z’, ‘text’, ‘name’] joined with ‘+’ characters +(e.g. ‘x+y’) +OR exactly one of [‘all’, ‘none’, ‘skip’] (e.g. ‘skip’)
+
A list or array of the above
+
+

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property hoverinfosrc¶

Sets the source reference on Chart Studio Cloud for hoverinfo +.

The ‘hoverinfosrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel +that may be specified as:

+
+
An instance of plotly.graph_objects.area.Hoverlabel
+
A dict of string/value properties that will be passed +to the Hoverlabel constructor
+
Supported dict properties:
+
+
+
align
Sets the horizontal alignment of the text +content within hover label box. Has an effect +only if the hover label text spans more two or +more lines
+
+
alignsrc
Sets the source reference on Chart Studio Cloud +for align .
+
+
bgcolor
Sets the background color of the hover labels +for this trace
+
+
bgcolorsrc
Sets the source reference on Chart Studio Cloud +for bgcolor .
+
+
bordercolor
Sets the border color of the hover labels for +this trace.
+
+
bordercolorsrc
Sets the source reference on Chart Studio Cloud +for bordercolor .
+
+
font
Sets the font used in hover labels.
+
+
namelength
Sets the default length (in number of +characters) of the trace name in the hover +labels for all traces. -1 shows the whole name +regardless of length. 0-3 shows the first 0-3 +characters, and an integer >3 will show the +whole name if it is less than that many +characters, but if it is longer, will truncate +to namelength - 3 characters and add an +ellipsis.
+
+
namelengthsrc
Sets the source reference on Chart Studio Cloud +for namelength .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.area.Hoverlabel
+

+ +

+property ids¶

Assigns id labels to each datum. These ids for object constancy +of data points during animation. Should be an array of strings, +not numbers or any other type.

The ‘ids’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property idssrc¶

Sets the source reference on Chart Studio Cloud for ids .

The ‘idssrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property legendgroup¶

Sets the legend group for this trace. Traces part of the same +legend group hide/show at the same time when toggling legend +items.

The ‘legendgroup’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property marker¶

The ‘marker’ property is an instance of Marker +that may be specified as:

+
+
An instance of plotly.graph_objects.area.Marker
+
A dict of string/value properties that will be passed +to the Marker constructor
+
Supported dict properties:
+
+
+
color
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets themarkercolor. +It accepts either a specific color or an array +of numbers that are mapped to the colorscale +relative to the max and min values of the array +or relative to marker.cmin and marker.cmax +if set.
+
+
colorsrc
Sets the source reference on Chart Studio Cloud +for color .
+
+
opacity
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets the marker +opacity.
+
+
opacitysrc
Sets the source reference on Chart Studio Cloud +for opacity .
+
+
size
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets the marker size +(in px).
+
+
sizesrc
Sets the source reference on Chart Studio Cloud +for size .
+
+
symbol
Area traces are deprecated! Please switch to +the “barpolar” trace type. Sets the marker +symbol type. Adding 100 is equivalent to +appending “-open” to a symbol name. Adding 200 +is equivalent to appending “-dot” to a symbol +name. Adding 300 is equivalent to appending +“-open-dot” or “dot-open” to a symbol name.
+
+
symbolsrc
Sets the source reference on Chart Studio Cloud +for symbol .
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.area.Marker
+

+ +

+property meta¶

The ‘meta’ property accepts values of any type

Returns: +
Return type: Any|numpy.ndarray
+

+ +

+property metasrc¶

Sets the source reference on Chart Studio Cloud for meta .

The ‘metasrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property name¶

Sets the trace name. The trace name appear as the legend item +and on hover.

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property opacity¶

Sets the opacity of the trace.

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns: +
Return type: int|float
+

+ +

+property r¶

Area traces are deprecated! Please switch to the “barpolar” +trace type. Sets the radial coordinates for legacy polar chart +only.

The ‘r’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property rsrc¶

Sets the source reference on Chart Studio Cloud for r .

The ‘rsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property showlegend¶

Determines whether or not an item corresponding to this trace +is shown in the legend.

The ‘showlegend’ property must be specified as a bool +(either True, or False)

Returns: +
Return type: bool
+

+ +

+property stream¶

The ‘stream’ property is an instance of Stream +that may be specified as:

+
+
An instance of plotly.graph_objects.area.Stream
+
A dict of string/value properties that will be passed +to the Stream constructor
+
Supported dict properties:
+
+
+
maxpoints
Sets the maximum number of points to keep on +the plots from an incoming stream. If +maxpoints is set to 50, only the newest 50 +points will be displayed on the plot.
+
+
token
The stream id number links a data trace on a +plot with a stream. See https://chart- +studio.plotly.com/settings for more details.
+
+
+
+
+
+

Returns: +
Return type: plotly.graph_objects.area.Stream
+

+ +

+property t¶

Area traces are deprecated! Please switch to the “barpolar” +trace type. Sets the angular coordinates for legacy polar chart +only.

The ‘t’ property is an array that may be specified as a tuple, +list, numpy array, or pandas Series

Returns: +
Return type: numpy.ndarray
+

+ +

+property tsrc¶

Sets the source reference on Chart Studio Cloud for t .

The ‘tsrc’ property must be specified as a string or +as a plotly.grid_objs.Column object

Returns: +
Return type: str
+

+ +

+property type¶

+ +

+property uid¶

Assign an id to this trace, Use this to provide object +constancy between traces during animations and transitions.

The ‘uid’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns: +
Return type: str
+

+ +

+property uirevision¶

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
+

+ +

+ + +

`__init__`([data, layout, frames, skip_invalid])	Create a new :class:Figure instance
`add_annotation`([arg, align, arrowcolor, …])	Create and add a new annotation to the figure’s layout
`add_area`([customdata, customdatasrc, …])	Add a new Area trace
`add_bar`([alignmentgroup, base, basesrc, …])	Add a new Bar trace
`add_barpolar`([base, basesrc, customdata, …])	Add a new Barpolar trace
`add_box`([alignmentgroup, boxmean, …])	Add a new Box trace
`add_candlestick`([close, closesrc, …])	Add a new Candlestick trace
`add_carpet`([a, a0, aaxis, asrc, b, b0, …])	Add a new Carpet trace
`add_choropleth`([autocolorscale, coloraxis, …])	Add a new Choropleth trace
`add_choroplethmapbox`([autocolorscale, …])	Add a new Choroplethmapbox trace
`add_cone`([anchor, autocolorscale, cauto, …])	Add a new Cone trace
`add_contour`([autocolorscale, autocontour, …])	Add a new Contour trace
`add_contourcarpet`([a, a0, asrc, atype, …])	Add a new Contourcarpet trace
`add_densitymapbox`([autocolorscale, below, …])	Add a new Densitymapbox trace
`add_funnel`([alignmentgroup, cliponaxis, …])	Add a new Funnel trace
`add_funnelarea`([aspectratio, baseratio, …])	Add a new Funnelarea trace
`add_heatmap`([autocolorscale, coloraxis, …])	Add a new Heatmap trace
`add_heatmapgl`([autocolorscale, coloraxis, …])	Add a new Heatmapgl trace
`add_histogram`([alignmentgroup, autobinx, …])	Add a new Histogram trace
`add_histogram2d`([autobinx, autobiny, …])	Add a new Histogram2d trace
`add_histogram2dcontour`([autobinx, autobiny, …])	Add a new Histogram2dContour trace
`add_image`([colormodel, customdata, …])	Add a new Image trace
`add_indicator`([align, customdata, …])	Add a new Indicator trace
`add_isosurface`([autocolorscale, caps, …])	Add a new Isosurface trace
`add_layout_image`([arg, layer, name, …])	Create and add a new image to the figure’s layout
`add_mesh3d`([alphahull, autocolorscale, …])	Add a new Mesh3d trace
`add_ohlc`([close, closesrc, customdata, …])	Add a new Ohlc trace
`add_parcats`([arrangement, bundlecolors, …])	Add a new Parcats trace
`add_parcoords`([customdata, customdatasrc, …])	Add a new Parcoords trace
`add_pie`([automargin, customdata, …])	Add a new Pie trace
`add_pointcloud`([customdata, customdatasrc, …])	Add a new Pointcloud trace
`add_sankey`([arrangement, customdata, …])	Add a new Sankey trace
`add_scatter`([cliponaxis, connectgaps, …])	Add a new Scatter trace
`add_scatter3d`([connectgaps, customdata, …])	Add a new Scatter3d trace
`add_scattercarpet`([a, asrc, b, bsrc, …])	Add a new Scattercarpet trace
`add_scattergeo`([connectgaps, customdata, …])	Add a new Scattergeo trace
`add_scattergl`([connectgaps, customdata, …])	Add a new Scattergl trace
`add_scattermapbox`([below, connectgaps, …])	Add a new Scattermapbox trace
`add_scatterpolar`([cliponaxis, connectgaps, …])	Add a new Scatterpolar trace
`add_scatterpolargl`([connectgaps, …])	Add a new Scatterpolargl trace
`add_scatterternary`([a, asrc, b, bsrc, c, …])	Add a new Scatterternary trace
`add_shape`([arg, fillcolor, layer, line, …])	Create and add a new shape to the figure’s layout
`add_splom`([customdata, customdatasrc, …])	Add a new Splom trace
`add_streamtube`([autocolorscale, cauto, …])	Add a new Streamtube trace
`add_sunburst`([branchvalues, count, …])	Add a new Sunburst trace
`add_surface`([autocolorscale, cauto, cmax, …])	Add a new Surface trace
`add_table`([cells, columnorder, …])	Add a new Table trace
`add_trace`(trace[, row, col, secondary_y])	Add a trace to the figure
`add_traces`(data[, rows, cols, secondary_ys])	Add traces to the figure
`add_treemap`([branchvalues, count, …])	Add a new Treemap trace
`add_violin`([alignmentgroup, bandwidth, box, …])	Add a new Violin trace
`add_volume`([autocolorscale, caps, cauto, …])	Add a new Volume trace
`add_waterfall`([alignmentgroup, base, …])	Add a new Waterfall trace
`append_trace`(trace, row, col)	Add a trace to the figure bound to axes at the specified row, col index.
`batch_animate`([duration, easing])	Context manager to animate trace / layout updates
`batch_update`()	A context manager that batches up trace and layout assignment operations into a singe plotly_update message that is executed when the context exits.
`for_each_annotation`(fn[, selector, row, …])	Apply a function to all annotations that satisfy the specified selection criteria
`for_each_coloraxis`(fn[, selector, row, col])	Apply a function to all coloraxis objects that satisfy the specified selection criteria
`for_each_geo`(fn[, selector, row, col])	Apply a function to all geo objects that satisfy the specified selection criteria
`for_each_layout_image`(fn[, selector, row, …])	Apply a function to all images that satisfy the specified selection criteria
`for_each_mapbox`(fn[, selector, row, col])	Apply a function to all mapbox objects that satisfy the specified selection criteria
`for_each_polar`(fn[, selector, row, col])	Apply a function to all polar objects that satisfy the specified selection criteria
`for_each_scene`(fn[, selector, row, col])	Apply a function to all scene objects that satisfy the specified selection criteria
`for_each_shape`(fn[, selector, row, col, …])	Apply a function to all shapes that satisfy the specified selection criteria
`for_each_ternary`(fn[, selector, row, col])	Apply a function to all ternary objects that satisfy the specified selection criteria
`for_each_trace`(fn[, selector, row, col, …])	Apply a function to all traces that satisfy the specified selection criteria
`for_each_xaxis`(fn[, selector, row, col])	Apply a function to all xaxis objects that satisfy the specified selection criteria
`for_each_yaxis`(fn[, selector, row, col, …])	Apply a function to all yaxis objects that satisfy the specified selection criteria
`get_subplot`(row, col[, secondary_y])	Return an object representing the subplot at the specified row and column.
`plotly_relayout`(relayout_data, **kwargs)	Perform a Plotly relayout operation on the figure’s layout
`plotly_restyle`(restyle_data[, trace_indexes])	Perform a Plotly restyle operation on the figure’s traces
`plotly_update`([restyle_data, relayout_data, …])	Perform a Plotly update operation on the figure.
`pop`(key, *args)	Remove the value associated with the specified key and return it
`print_grid`()	Print a visual layout of the figure’s axes arrangement.
`select_annotations`([selector, row, col, …])	Select annotations from a particular subplot cell and/or annotations that satisfy custom selection criteria.
`select_coloraxes`([selector, row, col])	Select coloraxis subplot objects from a particular subplot cell and/or coloraxis subplot objects that satisfy custom selection criteria.
`select_geos`([selector, row, col])	Select geo subplot objects from a particular subplot cell and/or geo subplot objects that satisfy custom selection criteria.
`select_layout_images`([selector, row, col, …])	Select images from a particular subplot cell and/or images that satisfy custom selection criteria.
`select_mapboxes`([selector, row, col])	Select mapbox subplot objects from a particular subplot cell and/or mapbox subplot objects that satisfy custom selection criteria.
`select_polars`([selector, row, col])	Select polar subplot objects from a particular subplot cell and/or polar subplot objects that satisfy custom selection criteria.
`select_scenes`([selector, row, col])	Select scene subplot objects from a particular subplot cell and/or scene subplot objects that satisfy custom selection criteria.
`select_shapes`([selector, row, col, secondary_y])	Select shapes from a particular subplot cell and/or shapes that satisfy custom selection criteria.
`select_ternaries`([selector, row, col])	Select ternary subplot objects from a particular subplot cell and/or ternary subplot objects that satisfy custom selection criteria.
`select_traces`([selector, row, col, secondary_y])	Select traces from a particular subplot cell and/or traces that satisfy custom selection criteria.
`select_xaxes`([selector, row, col])	Select xaxis subplot objects from a particular subplot cell and/or xaxis subplot objects that satisfy custom selection criteria.
`select_yaxes`([selector, row, col, secondary_y])	Select yaxis subplot objects from a particular subplot cell and/or yaxis subplot objects that satisfy custom selection criteria.
`show`(args, *kwargs)	Show a figure using either the default renderer(s) or the renderer(s) specified by the renderer argument
`to_dict`()	Convert figure to a dictionary
`to_html`(args, *kwargs)	Convert a figure to an HTML string representation.
`to_image`(args, *kwargs)	Convert a figure to a static image bytes string
`to_json`(args, *kwargs)	Convert a figure to a JSON string representation
`to_ordered_dict`([skip_uid])
`to_plotly_json`()	Convert figure to a JSON representation as a Python dict
`update`([dict1, overwrite])	Update the properties of the figure with a dict and/or with keyword arguments.
`update_annotations`([patch, selector, row, …])	Perform a property update operation on all annotations that satisfy the specified selection criteria
`update_coloraxes`([patch, selector, …])	Perform a property update operation on all coloraxis objects that satisfy the specified selection criteria
`update_geos`([patch, selector, overwrite, …])	Perform a property update operation on all geo objects that satisfy the specified selection criteria
`update_layout`([dict1, overwrite])	Update the properties of the figure’s layout with a dict and/or with keyword arguments.
`update_layout_images`([patch, selector, row, …])	Perform a property update operation on all images that satisfy the specified selection criteria
`update_mapboxes`([patch, selector, …])	Perform a property update operation on all mapbox objects that satisfy the specified selection criteria
`update_polars`([patch, selector, overwrite, …])	Perform a property update operation on all polar objects that satisfy the specified selection criteria
`update_scenes`([patch, selector, overwrite, …])	Perform a property update operation on all scene objects that satisfy the specified selection criteria
`update_shapes`([patch, selector, row, col, …])	Perform a property update operation on all shapes that satisfy the specified selection criteria
`update_ternaries`([patch, selector, …])	Perform a property update operation on all ternary objects that satisfy the specified selection criteria
`update_traces`([patch, selector, row, col, …])	Perform a property update operation on all traces that satisfy the specified selection criteria
`update_xaxes`([patch, selector, overwrite, …])	Perform a property update operation on all xaxis objects that satisfy the specified selection criteria
`update_yaxes`([patch, selector, overwrite, …])	Perform a property update operation on all yaxis objects that satisfy the specified selection criteria
`write_html`(args, *kwargs)	Write a figure to an HTML file representation
`write_image`(args, *kwargs)	Convert a figure to a static image and write it to a file or writeable object
`write_json`(args, *kwargs)	Convert a figure to JSON and write it to a file or writeable object

`data`	The `data` property is a tuple of the figure’s trace objects
`frames`	The `frames` property is a tuple of the figure’s frame objects
`layout`	The `layout` property of the figure

`__init__`([data, layout_plotly, frames, …])	Construct a BaseFigure object
`add_trace`(trace[, row, col, secondary_y])	Add a trace to the figure
`add_traces`(data[, rows, cols, secondary_ys])	Add traces to the figure
`append_trace`(trace, row, col)	Add a trace to the figure bound to axes at the specified row, col index.
`batch_animate`([duration, easing])	Context manager to animate trace / layout updates
`batch_update`()	A context manager that batches up trace and layout assignment operations into a singe plotly_update message that is executed when the context exits.
`for_each_trace`(fn[, selector, row, col, …])	Apply a function to all traces that satisfy the specified selection criteria
`get_subplot`(row, col[, secondary_y])	Return an object representing the subplot at the specified row and column.
`plotly_relayout`(relayout_data, **kwargs)	Perform a Plotly relayout operation on the figure’s layout
`plotly_restyle`(restyle_data[, trace_indexes])	Perform a Plotly restyle operation on the figure’s traces
`plotly_update`([restyle_data, relayout_data, …])	Perform a Plotly update operation on the figure.
`pop`(key, *args)	Remove the value associated with the specified key and return it
`print_grid`()	Print a visual layout of the figure’s axes arrangement.
`select_traces`([selector, row, col, secondary_y])	Select traces from a particular subplot cell and/or traces that satisfy custom selection criteria.
`show`(args, *kwargs)	Show a figure using either the default renderer(s) or the renderer(s) specified by the renderer argument
`to_dict`()	Convert figure to a dictionary
`to_html`(args, *kwargs)	Convert a figure to an HTML string representation.
`to_image`(args, *kwargs)	Convert a figure to a static image bytes string
`to_json`(args, *kwargs)	Convert a figure to a JSON string representation
`to_ordered_dict`([skip_uid])
`to_plotly_json`()	Convert figure to a JSON representation as a Python dict
`update`([dict1, overwrite])	Update the properties of the figure with a dict and/or with keyword arguments.
`update_layout`([dict1, overwrite])	Update the properties of the figure’s layout with a dict and/or with keyword arguments.
`update_traces`([patch, selector, row, col, …])	Perform a property update operation on all traces that satisfy the specified selection criteria
`write_html`(args, *kwargs)	Write a figure to an HTML file representation
`write_image`(args, *kwargs)	Convert a figure to a static image and write it to a file or writeable object
`write_json`(args, *kwargs)	Convert a figure to JSON and write it to a file or writeable object

`data`	The `data` property is a tuple of the figure’s trace objects
`frames`	The `frames` property is a tuple of the figure’s frame objects
`layout`	The `layout` property of the figure

`Figure`([data, layout, frames, skip_invalid])
`Figure.show`(args, *kwargs)	Show a figure using either the default renderer(s) or the renderer(s) specified by the renderer argument
`Figure.add_traces`(data[, rows, cols, …])	Add traces to the figure
`Figure.update_traces`([patch, selector, row, …])	Perform a property update operation on all traces that satisfy the specified selection criteria
`Figure.update_layout`([dict1, overwrite])	Update the properties of the figure’s layout with a dict and/or with keyword arguments.

`scatter`([data_frame, x, y, color, symbol, …])	In a scatter plot, each row of `data_frame` is represented by a symbol
`scatter_3d`([data_frame, x, y, z, color, …])	In a 3D scatter plot, each row of `data_frame` is represented by a
`scatter_polar`([data_frame, r, theta, color, …])	In a polar scatter plot, each row of `data_frame` is represented by a
`scatter_ternary`([data_frame, a, b, c, …])	In a ternary scatter plot, each row of `data_frame` is represented by a
`scatter_mapbox`([data_frame, lat, lon, …])	In a Mapbox scatter plot, each row of `data_frame` is represented by a
`scatter_geo`([data_frame, lat, lon, …])	In a geographic scatter plot, each row of `data_frame` is represented
`line`([data_frame, x, y, line_group, color, …])	In a 2D line plot, each row of `data_frame` is represented as vertex of
`line_3d`([data_frame, x, y, z, color, …])	In a 3D line plot, each row of `data_frame` is represented as vertex of
`line_polar`([data_frame, r, theta, color, …])	In a polar line plot, each row of `data_frame` is represented as vertex
`line_ternary`([data_frame, a, b, c, color, …])	In a ternary line plot, each row of `data_frame` is represented as
`line_mapbox`([data_frame, lat, lon, color, …])	In a Mapbox line plot, each row of `data_frame` is represented as
`line_geo`([data_frame, lat, lon, locations, …])	In a geographic line plot, each row of `data_frame` is represented as
`area`([data_frame, x, y, line_group, color, …])	In a stacked area plot, each row of `data_frame` is represented as
`bar`([data_frame, x, y, color, facet_row, …])	In a bar plot, each row of `data_frame` is represented as a rectangular
`bar_polar`([data_frame, r, theta, color, …])	In a polar bar plot, each row of `data_frame` is represented as a wedge
`violin`([data_frame, x, y, color, facet_row, …])	In a violin plot, rows of `data_frame` are grouped together into a
`box`([data_frame, x, y, color, facet_row, …])	In a box plot, rows of `data_frame` are grouped together into a
`strip`([data_frame, x, y, color, facet_row, …])	In a strip plot each row of `data_frame` is represented as a jittered
`histogram`([data_frame, x, y, color, …])	In a histogram, rows of `data_frame` are grouped together into a
`pie`([data_frame, names, values, color, …])	In a pie plot, each row of `data_frame` is represented as a sector of a
`treemap`([data_frame, names, values, …])	A treemap plot represents hierarchial data as nested rectangular
`sunburst`([data_frame, names, values, …])	A sunburst plot represents hierarchial data as sectors laid out over
`funnel`([data_frame, x, y, color, facet_row, …])	In a funnel plot, each row of `data_frame` is represented as a
`funnel_area`([data_frame, names, values, …])	In a funnel area plot, each row of `data_frame` is represented as a
`scatter_matrix`([data_frame, dimensions, …])	In a scatter plot matrix (or SPLOM), each row of `data_frame` is
`parallel_coordinates`([data_frame, …])	In a parallel coordinates plot, each row of `data_frame` is represented
`parallel_categories`([data_frame, …])	In a parallel categories (or parallel sets) plot, each row of
`choropleth`([data_frame, lat, lon, …])	In a choropleth map, each row of `data_frame` is represented by a
`choropleth_mapbox`([data_frame, geojson, …])	In a Mapbox choropleth map, each row of `data_frame` is represented by a
`density_contour`([data_frame, x, y, z, …])	In a density contour plot, rows of `data_frame` are grouped together
`density_heatmap`([data_frame, x, y, z, …])	In a density heatmap, rows of `data_frame` are grouped together into
`density_mapbox`([data_frame, lat, lon, z, …])	In a Mapbox density map, each row of `data_frame` contributes to the intensity of
`imshow`(img[, zmin, zmax, origin, labels, x, …])	Display an image, i.e.

`create_2d_density`(x, y[, colorscale, …])	deprecated, use instead `plotly.express.density_heatmap()`.
`create_annotated_heatmap`(z[, x, y, …])	Function that creates annotated heatmaps
`create_bullet`(data[, markers, measures, …])	deprecated, use instead the plotly.graph_objects trace `plotly.graph_objects.Indicator`.
`create_candlestick`(open, high, low, close[, …])	deprecated, use instead the plotly.graph_objects trace `plotly.graph_objects.Candlestick`
`create_dendrogram`(X[, orientation, labels, …])	Function that returns a dendrogram Plotly figure object.
`create_distplot`(hist_data, group_labels[, …])	Function that creates a distplot similar to seaborn.distplot; this function is deprecated, use instead `plotly.express` functions, for example
`create_facet_grid`(df[, x, y, facet_row, …])	Returns figure for facet grid; this function is deprecated, since plotly.express functions should be used instead, for example
`create_gantt`(df[, colors, index_col, …])	Returns figure for a gantt chart
`create_ohlc`(open, high, low, close[, dates, …])	deprecated, use instead the plotly.graph_objects trace `plotly.graph_objects.Ohlc`
`create_quiver`(x, y, u, v[, scale, …])	Returns data for a quiver plot.
`create_scatterplotmatrix`(df[, index, …])	Returns data for a scatterplot matrix; deprecated, use instead the plotly.graph_objects trace `plotly.graph_objects.Splom`.
`create_streamline`(x, y, u, v[, density, …])	Returns data for a streamline plot.
`create_table`(table_text[, colorscale, …])	Function that creates data tables.
`create_ternary_contour`(coordinates, values)	Ternary contour plot.
`create_trisurf`(x, y, z, simplices[, …])	Returns figure for a triangulated surface plot
`create_violin`(data[, data_header, …])	deprecated, use instead the plotly.graph_objects trace `plotly.graph_objects.Violin`.

`Scatter`([arg, cliponaxis, connectgaps, …])
`Scattergl`([arg, connectgaps, customdata, …])
`Bar`([arg, alignmentgroup, base, basesrc, …])
`Pie`([arg, automargin, customdata, …])
`Heatmap`([arg, autocolorscale, coloraxis, …])
`Image`([arg, colormodel, customdata, …])
`Contour`([arg, autocolorscale, autocontour, …])
`Table`([arg, cells, columnorder, …])

`Box`([arg, alignmentgroup, boxmean, …])
`Violin`([arg, alignmentgroup, bandwidth, …])
`Histogram`([arg, alignmentgroup, autobinx, …])
`Histogram2d`([arg, autobinx, autobiny, …])
`Histogram2dContour`([arg, autobinx, …])

`Ohlc`([arg, close, closesrc, customdata, …])
`Candlestick`([arg, close, closesrc, …])
`Waterfall`([arg, alignmentgroup, base, …])
`Funnel`([arg, alignmentgroup, cliponaxis, …])
`Funnelarea`([arg, aspectratio, baseratio, …])
`Indicator`([arg, align, customdata, …])

`Scatter3d`([arg, connectgaps, customdata, …])
`Surface`([arg, autocolorscale, cauto, cmax, …])
`Mesh3d`([arg, alphahull, autocolorscale, …])
`Cone`([arg, anchor, autocolorscale, cauto, …])
`Streamtube`([arg, autocolorscale, cauto, …])
`Volume`([arg, autocolorscale, caps, cauto, …])
`Isosurface`([arg, autocolorscale, caps, …])

`Scattergeo`([arg, connectgaps, customdata, …])
`Choropleth`([arg, autocolorscale, coloraxis, …])
`Scattermapbox`([arg, below, connectgaps, …])
`Choroplethmapbox`([arg, autocolorscale, …])
`Densitymapbox`([arg, autocolorscale, below, …])

`Scatterpolar`([arg, cliponaxis, connectgaps, …])
`Scatterpolargl`([arg, connectgaps, …])
`Barpolar`([arg, base, basesrc, customdata, …])
`Scatterternary`([arg, a, asrc, b, bsrc, c, …])
`Sunburst`([arg, branchvalues, count, …])
`Treemap`([arg, branchvalues, count, …])
`Sankey`([arg, arrangement, customdata, …])
`Splom`([arg, customdata, customdatasrc, …])
`Parcats`([arg, arrangement, bundlecolors, …])
`Parcoords`([arg, customdata, customdatasrc, …])
`Carpet`([arg, a, a0, aaxis, asrc, b, b0, …])
`Scattercarpet`([arg, a, asrc, b, bsrc, …])
`Contourcarpet`([arg, a, a0, asrc, atype, …])

`to_image`(fig[, format, width, height, …])	Convert a figure to a static image bytes string
`write_image`(fig, file[, format, scale, …])	Convert a figure to a static image and write it to a file or writeable object
`to_json`(fig[, validate, pretty, remove_uids])	Convert a figure to a JSON string representation
`from_json`(value[, output_type, skip_invalid])	Construct a figure from a JSON string
`read_json`(file[, output_type, skip_invalid])	Construct a figure from the JSON contents of a local file or readable Python object
`write_json`(fig, file[, validate, pretty, …])	Convert a figure to JSON and write it to a file or writeable object
`templates`	Singleton object containing the current figure templates (aka themes)
`to_templated`(fig[, skip])	Return a copy of a figure where all styling properties have been moved into the figure’s template.
`to_html`(fig[, config, auto_play, …])	Convert a figure to an HTML string representation.
`write_html`(fig, file[, config, auto_play, …])	Write a figure to an HTML file representation
`renderers`	Singleton object containing the current renderer configurations
`show`(fig[, renderer, validate])	Show a figure using either the default renderer(s) or the renderer(s) specified by the renderer argument


	+ p
	+ `plotly`	+
	+ `plotly.animation`	+
	+ `plotly.basedatatypes`	+
	+ `plotly.basewidget`	+
	+ `plotly.callbacks`	+
	+ `plotly.colors`	+
	+ `plotly.conftest`	+
	+ `plotly.data`	+
	+ `plotly.exceptions`	+
	+ `plotly.express`	+
	+ `plotly.express.colors`	+
	+ `plotly.express.data`	+
	+ `plotly.figure_factory`	+
	+ `plotly.figure_factory.utils`	+
	+ `plotly.files`	+
	+ `plotly.graph_objects`	+
	+ `plotly.graph_objects.bar`	+
	+ `plotly.graph_objects.barpolar`	+
	+ `plotly.graph_objects.box`	+
	+ `plotly.graph_objects.candlestick`	+
	+ `plotly.graph_objects.carpet`	+
	+ `plotly.graph_objects.choropleth`	+
	+ `plotly.graph_objects.choroplethmapbox`	+
	+ `plotly.graph_objects.cone`	+
	+ `plotly.graph_objects.contour`	+
	+ `plotly.graph_objects.contourcarpet`	+
	+ `plotly.graph_objects.densitymapbox`	+
	+ `plotly.graph_objects.funnel`	+
	+ `plotly.graph_objects.funnelarea`	+
	+ `plotly.graph_objects.heatmap`	+
	+ `plotly.graph_objects.histogram`	+
	+ `plotly.graph_objects.histogram2d`	+
	+ `plotly.graph_objects.histogram2dcontour`	+
	+ `plotly.graph_objects.image`	+
	+ `plotly.graph_objects.indicator`	+
	+ `plotly.graph_objects.isosurface`	+
	+ `plotly.graph_objects.layout`	+
	+ `plotly.graph_objects.mesh3d`	+
	+ `plotly.graph_objects.ohlc`	+
	+ `plotly.graph_objects.parcats`	+
	+ `plotly.graph_objects.parcoords`	+
	+ `plotly.graph_objects.pie`	+
	+ `plotly.graph_objects.sankey`	+
	+ `plotly.graph_objects.scatter`	+
	+ `plotly.graph_objects.scatter3d`	+
	+ `plotly.graph_objects.scattercarpet`	+
	+ `plotly.graph_objects.scattergeo`	+
	+ `plotly.graph_objects.scattergl`	+
	+ `plotly.graph_objects.scattermapbox`	+
	+ `plotly.graph_objects.scatterpolar`	+
	+ `plotly.graph_objects.scatterpolargl`	+
	+ `plotly.graph_objects.scatterternary`	+
	+ `plotly.graph_objects.splom`	+
	+ `plotly.graph_objects.streamtube`	+
	+ `plotly.graph_objects.sunburst`	+
	+ `plotly.graph_objects.surface`	+
	+ `plotly.graph_objects.table`	+
	+ `plotly.graph_objects.treemap`	+
	+ `plotly.graph_objects.violin`	+
	+ `plotly.graph_objects.volume`	+
	+ `plotly.graph_objects.waterfall`	+
	+ `plotly.graph_objects`	+
	+ `plotly.graph_objects.area`	+
	+ `plotly.graph_objects.area.hoverlabel`	+
	+ `plotly.graph_objects.bar`	+
	+ `plotly.graph_objects.bar.hoverlabel`	+
	+ `plotly.graph_objects.bar.marker`	+
	+ `plotly.graph_objects.bar.marker.colorbar`	+
	+ `plotly.graph_objects.bar.marker.colorbar.title`	+
	+ `plotly.graph_objects.bar.selected`	+
	+ `plotly.graph_objects.bar.unselected`	+
	+ `plotly.graph_objects.barpolar`	+
	+ `plotly.graph_objects.barpolar.hoverlabel`	+
	+ `plotly.graph_objects.barpolar.marker`	+
	+ `plotly.graph_objects.barpolar.marker.colorbar`	+
	+ `plotly.graph_objects.barpolar.marker.colorbar.title`	+
	+ `plotly.graph_objects.barpolar.selected`	+
	+ `plotly.graph_objects.barpolar.unselected`	+
	+ `plotly.graph_objects.box`	+
	+ `plotly.graph_objects.box.hoverlabel`	+
	+ `plotly.graph_objects.box.marker`	+
	+ `plotly.graph_objects.box.selected`	+
	+ `plotly.graph_objects.box.unselected`	+
	+ `plotly.graph_objects.candlestick`	+
	+ `plotly.graph_objects.candlestick.decreasing`	+
	+ `plotly.graph_objects.candlestick.hoverlabel`	+
	+ `plotly.graph_objects.candlestick.increasing`	+
	+ `plotly.graph_objects.carpet`	+
	+ `plotly.graph_objects.carpet.aaxis`	+
	+ `plotly.graph_objects.carpet.aaxis.title`	+
	+ `plotly.graph_objects.carpet.baxis`	+
	+ `plotly.graph_objects.carpet.baxis.title`	+
	+ `plotly.graph_objects.choropleth`	+
	+ `plotly.graph_objects.choropleth.colorbar`	+
	+ `plotly.graph_objects.choropleth.colorbar.title`	+
	+ `plotly.graph_objects.choropleth.hoverlabel`	+
	+ `plotly.graph_objects.choropleth.marker`	+
	+ `plotly.graph_objects.choropleth.selected`	+
	+ `plotly.graph_objects.choropleth.unselected`	+
	+ `plotly.graph_objects.choroplethmapbox`	+
	+ `plotly.graph_objects.choroplethmapbox.colorbar`	+
	+ `plotly.graph_objects.choroplethmapbox.colorbar.title`	+
	+ `plotly.graph_objects.choroplethmapbox.hoverlabel`	+
	+ `plotly.graph_objects.choroplethmapbox.marker`	+
	+ `plotly.graph_objects.choroplethmapbox.selected`	+
	+ `plotly.graph_objects.choroplethmapbox.unselected`	+
	+ `plotly.graph_objects.cone`	+
	+ `plotly.graph_objects.cone.colorbar`	+
	+ `plotly.graph_objects.cone.colorbar.title`	+
	+ `plotly.graph_objects.cone.hoverlabel`	+
	+ `plotly.graph_objects.contour`	+
	+ `plotly.graph_objects.contour.colorbar`	+
	+ `plotly.graph_objects.contour.colorbar.title`	+
	+ `plotly.graph_objects.contour.contours`	+
	+ `plotly.graph_objects.contour.hoverlabel`	+
	+ `plotly.graph_objects.contourcarpet`	+
	+ `plotly.graph_objects.contourcarpet.colorbar`	+
	+ `plotly.graph_objects.contourcarpet.colorbar.title`	+
	+ `plotly.graph_objects.contourcarpet.contours`	+
	+ `plotly.graph_objects.densitymapbox`	+
	+ `plotly.graph_objects.densitymapbox.colorbar`	+
	+ `plotly.graph_objects.densitymapbox.colorbar.title`	+
	+ `plotly.graph_objects.densitymapbox.hoverlabel`	+
	+ `plotly.graph_objects.funnel`	+
	+ `plotly.graph_objects.funnel.connector`	+
	+ `plotly.graph_objects.funnel.hoverlabel`	+
	+ `plotly.graph_objects.funnel.marker`	+
	+ `plotly.graph_objects.funnel.marker.colorbar`	+
	+ `plotly.graph_objects.funnel.marker.colorbar.title`	+
	+ `plotly.graph_objects.funnelarea`	+
	+ `plotly.graph_objects.funnelarea.hoverlabel`	+
	+ `plotly.graph_objects.funnelarea.marker`	+
	+ `plotly.graph_objects.funnelarea.title`	+
	+ `plotly.graph_objects.graph_objects`	+
	+ `plotly.graph_objects.heatmap`	+
	+ `plotly.graph_objects.heatmap.colorbar`	+
	+ `plotly.graph_objects.heatmap.colorbar.title`	+
	+ `plotly.graph_objects.heatmap.hoverlabel`	+
	+ `plotly.graph_objects.heatmapgl`	+
	+ `plotly.graph_objects.heatmapgl.colorbar`	+
	+ `plotly.graph_objects.heatmapgl.colorbar.title`	+
	+ `plotly.graph_objects.heatmapgl.hoverlabel`	+
	+ `plotly.graph_objects.histogram`	+
	+ `plotly.graph_objects.histogram.hoverlabel`	+
	+ `plotly.graph_objects.histogram.marker`	+
	+ `plotly.graph_objects.histogram.marker.colorbar`	+
	+ `plotly.graph_objects.histogram.marker.colorbar.title`	+
	+ `plotly.graph_objects.histogram.selected`	+
	+ `plotly.graph_objects.histogram.unselected`	+
	+ `plotly.graph_objects.histogram2d`	+
	+ `plotly.graph_objects.histogram2d.colorbar`	+
	+ `plotly.graph_objects.histogram2d.colorbar.title`	+
	+ `plotly.graph_objects.histogram2d.hoverlabel`	+
	+ `plotly.graph_objects.histogram2dcontour`	+
	+ `plotly.graph_objects.histogram2dcontour.colorbar`	+
	+ `plotly.graph_objects.histogram2dcontour.colorbar.title`	+
	+ `plotly.graph_objects.histogram2dcontour.contours`	+
	+ `plotly.graph_objects.histogram2dcontour.hoverlabel`	+
	+ `plotly.graph_objects.image`	+
	+ `plotly.graph_objects.image.hoverlabel`	+
	+ `plotly.graph_objects.indicator`	+
	+ `plotly.graph_objects.indicator.delta`	+
	+ `plotly.graph_objects.indicator.gauge`	+
	+ `plotly.graph_objects.indicator.gauge.axis`	+
	+ `plotly.graph_objects.indicator.gauge.bar`	+
	+ `plotly.graph_objects.indicator.gauge.step`	+
	+ `plotly.graph_objects.indicator.gauge.threshold`	+
	+ `plotly.graph_objects.indicator.number`	+
	+ `plotly.graph_objects.indicator.title`	+
	+ `plotly.graph_objects.isosurface`	+
	+ `plotly.graph_objects.isosurface.caps`	+
	+ `plotly.graph_objects.isosurface.colorbar`	+
	+ `plotly.graph_objects.isosurface.colorbar.title`	+
	+ `plotly.graph_objects.isosurface.hoverlabel`	+
	+ `plotly.graph_objects.isosurface.slices`	+
	+ `plotly.graph_objects.layout`	+
	+ `plotly.graph_objects.layout.annotation`	+
	+ `plotly.graph_objects.layout.annotation.hoverlabel`	+
	+ `plotly.graph_objects.layout.coloraxis`	+
	+ `plotly.graph_objects.layout.coloraxis.colorbar`	+
	+ `plotly.graph_objects.layout.coloraxis.colorbar.title`	+
	+ `plotly.graph_objects.layout.geo`	+
	+ `plotly.graph_objects.layout.geo.projection`	+
	+ `plotly.graph_objects.layout.grid`	+
	+ `plotly.graph_objects.layout.hoverlabel`	+
	+ `plotly.graph_objects.layout.legend`	+
	+ `plotly.graph_objects.layout.legend.title`	+
	+ `plotly.graph_objects.layout.mapbox`	+
	+ `plotly.graph_objects.layout.mapbox.layer`	+
	+ `plotly.graph_objects.layout.mapbox.layer.symbol`	+
	+ `plotly.graph_objects.layout.newshape`	+
	+ `plotly.graph_objects.layout.polar`	+
	+ `plotly.graph_objects.layout.polar.angularaxis`	+
	+ `plotly.graph_objects.layout.polar.radialaxis`	+
	+ `plotly.graph_objects.layout.polar.radialaxis.title`	+
	+ `plotly.graph_objects.layout.scene`	+
	+ `plotly.graph_objects.layout.scene.annotation`	+
	+ `plotly.graph_objects.layout.scene.annotation.hoverlabel`	+
	+ `plotly.graph_objects.layout.scene.camera`	+
	+ `plotly.graph_objects.layout.scene.xaxis`	+
	+ `plotly.graph_objects.layout.scene.xaxis.title`	+
	+ `plotly.graph_objects.layout.scene.yaxis`	+
	+ `plotly.graph_objects.layout.scene.yaxis.title`	+
	+ `plotly.graph_objects.layout.scene.zaxis`	+
	+ `plotly.graph_objects.layout.scene.zaxis.title`	+
	+ `plotly.graph_objects.layout.shape`	+
	+ `plotly.graph_objects.layout.slider`	+
	+ `plotly.graph_objects.layout.slider.currentvalue`	+
	+ `plotly.graph_objects.layout.template`	+
	+ `plotly.graph_objects.layout.template.data`	+
	+ `plotly.graph_objects.layout.ternary`	+
	+ `plotly.graph_objects.layout.ternary.aaxis`	+
	+ `plotly.graph_objects.layout.ternary.aaxis.title`	+
	+ `plotly.graph_objects.layout.ternary.baxis`	+
	+ `plotly.graph_objects.layout.ternary.baxis.title`	+
	+ `plotly.graph_objects.layout.ternary.caxis`	+
	+ `plotly.graph_objects.layout.ternary.caxis.title`	+
	+ `plotly.graph_objects.layout.title`	+
	+ `plotly.graph_objects.layout.updatemenu`	+
	+ `plotly.graph_objects.layout.xaxis`	+
	+ `plotly.graph_objects.layout.xaxis.rangeselector`	+
	+ `plotly.graph_objects.layout.xaxis.rangeslider`	+
	+ `plotly.graph_objects.layout.xaxis.title`	+
	+ `plotly.graph_objects.layout.yaxis`	+
	+ `plotly.graph_objects.layout.yaxis.title`	+
	+ `plotly.graph_objects.mesh3d`	+
	+ `plotly.graph_objects.mesh3d.colorbar`	+
	+ `plotly.graph_objects.mesh3d.colorbar.title`	+
	+ `plotly.graph_objects.mesh3d.hoverlabel`	+
	+ `plotly.graph_objects.ohlc`	+
	+ `plotly.graph_objects.ohlc.decreasing`	+
	+ `plotly.graph_objects.ohlc.hoverlabel`	+
	+ `plotly.graph_objects.ohlc.increasing`	+
	+ `plotly.graph_objects.parcats`	+
	+ `plotly.graph_objects.parcats.line`	+
	+ `plotly.graph_objects.parcats.line.colorbar`	+
	+ `plotly.graph_objects.parcats.line.colorbar.title`	+
	+ `plotly.graph_objects.parcoords`	+
	+ `plotly.graph_objects.parcoords.line`	+
	+ `plotly.graph_objects.parcoords.line.colorbar`	+
	+ `plotly.graph_objects.parcoords.line.colorbar.title`	+
	+ `plotly.graph_objects.pie`	+
	+ `plotly.graph_objects.pie.hoverlabel`	+
	+ `plotly.graph_objects.pie.marker`	+
	+ `plotly.graph_objects.pie.title`	+
	+ `plotly.graph_objects.pointcloud`	+
	+ `plotly.graph_objects.pointcloud.hoverlabel`	+
	+ `plotly.graph_objects.pointcloud.marker`	+
	+ `plotly.graph_objects.sankey`	+
	+ `plotly.graph_objects.sankey.hoverlabel`	+
	+ `plotly.graph_objects.sankey.link`	+
	+ `plotly.graph_objects.sankey.link.hoverlabel`	+
	+ `plotly.graph_objects.sankey.node`	+
	+ `plotly.graph_objects.sankey.node.hoverlabel`	+
	+ `plotly.graph_objects.scatter`	+
	+ `plotly.graph_objects.scatter.hoverlabel`	+
	+ `plotly.graph_objects.scatter.marker`	+
	+ `plotly.graph_objects.scatter.marker.colorbar`	+
	+ `plotly.graph_objects.scatter.marker.colorbar.title`	+
	+ `plotly.graph_objects.scatter.selected`	+
	+ `plotly.graph_objects.scatter.unselected`	+
	+ `plotly.graph_objects.scatter3d`	+
	+ `plotly.graph_objects.scatter3d.hoverlabel`	+
	+ `plotly.graph_objects.scatter3d.line`	+
	+ `plotly.graph_objects.scatter3d.line.colorbar`	+
	+ `plotly.graph_objects.scatter3d.line.colorbar.title`	+
	+ `plotly.graph_objects.scatter3d.marker`	+
	+ `plotly.graph_objects.scatter3d.marker.colorbar`	+
	+ `plotly.graph_objects.scatter3d.marker.colorbar.title`	+
	+ `plotly.graph_objects.scatter3d.projection`	+
	+ `plotly.graph_objects.scattercarpet`	+
	+ `plotly.graph_objects.scattercarpet.hoverlabel`	+
	+ `plotly.graph_objects.scattercarpet.marker`	+
	+ `plotly.graph_objects.scattercarpet.marker.colorbar`	+
	+ `plotly.graph_objects.scattercarpet.marker.colorbar.title`	+
	+ `plotly.graph_objects.scattercarpet.selected`	+
	+ `plotly.graph_objects.scattercarpet.unselected`	+
	+ `plotly.graph_objects.scattergeo`	+
	+ `plotly.graph_objects.scattergeo.hoverlabel`	+
	+ `plotly.graph_objects.scattergeo.marker`	+
	+ `plotly.graph_objects.scattergeo.marker.colorbar`	+
	+ `plotly.graph_objects.scattergeo.marker.colorbar.title`	+
	+ `plotly.graph_objects.scattergeo.selected`	+
	+ `plotly.graph_objects.scattergeo.unselected`	+
	+ `plotly.graph_objects.scattergl`	+
	+ `plotly.graph_objects.scattergl.hoverlabel`	+
	+ `plotly.graph_objects.scattergl.marker`	+
	+ `plotly.graph_objects.scattergl.marker.colorbar`	+
	+ `plotly.graph_objects.scattergl.marker.colorbar.title`	+
	+ `plotly.graph_objects.scattergl.selected`	+
	+ `plotly.graph_objects.scattergl.unselected`	+
	+ `plotly.graph_objects.scattermapbox`	+
	+ `plotly.graph_objects.scattermapbox.hoverlabel`	+
	+ `plotly.graph_objects.scattermapbox.marker`	+
	+ `plotly.graph_objects.scattermapbox.marker.colorbar`	+
	+ `plotly.graph_objects.scattermapbox.marker.colorbar.title`	+
	+ `plotly.graph_objects.scattermapbox.selected`	+
	+ `plotly.graph_objects.scattermapbox.unselected`	+
	+ `plotly.graph_objects.scatterpolar`	+
	+ `plotly.graph_objects.scatterpolar.hoverlabel`	+
	+ `plotly.graph_objects.scatterpolar.marker`	+
	+ `plotly.graph_objects.scatterpolar.marker.colorbar`	+
	+ `plotly.graph_objects.scatterpolar.marker.colorbar.title`	+
	+ `plotly.graph_objects.scatterpolar.selected`	+
	+ `plotly.graph_objects.scatterpolar.unselected`	+
	+ `plotly.graph_objects.scatterpolargl`	+
	+ `plotly.graph_objects.scatterpolargl.hoverlabel`	+
	+ `plotly.graph_objects.scatterpolargl.marker`	+
	+ `plotly.graph_objects.scatterpolargl.marker.colorbar`	+
	+ `plotly.graph_objects.scatterpolargl.marker.colorbar.title`	+
	+ `plotly.graph_objects.scatterpolargl.selected`	+
	+ `plotly.graph_objects.scatterpolargl.unselected`	+
	+ `plotly.graph_objects.scatterternary`	+
	+ `plotly.graph_objects.scatterternary.hoverlabel`	+
	+ `plotly.graph_objects.scatterternary.marker`	+
	+ `plotly.graph_objects.scatterternary.marker.colorbar`	+
	+ `plotly.graph_objects.scatterternary.marker.colorbar.title`	+
	+ `plotly.graph_objects.scatterternary.selected`	+
	+ `plotly.graph_objects.scatterternary.unselected`	+
	+ `plotly.graph_objects.splom`	+
	+ `plotly.graph_objects.splom.dimension`	+
	+ `plotly.graph_objects.splom.hoverlabel`	+
	+ `plotly.graph_objects.splom.marker`	+
	+ `plotly.graph_objects.splom.marker.colorbar`	+
	+ `plotly.graph_objects.splom.marker.colorbar.title`	+
	+ `plotly.graph_objects.splom.selected`	+
	+ `plotly.graph_objects.splom.unselected`	+
	+ `plotly.graph_objects.streamtube`	+
	+ `plotly.graph_objects.streamtube.colorbar`	+
	+ `plotly.graph_objects.streamtube.colorbar.title`	+
	+ `plotly.graph_objects.streamtube.hoverlabel`	+
	+ `plotly.graph_objects.sunburst`	+
	+ `plotly.graph_objects.sunburst.hoverlabel`	+
	+ `plotly.graph_objects.sunburst.marker`	+
	+ `plotly.graph_objects.sunburst.marker.colorbar`	+
	+ `plotly.graph_objects.sunburst.marker.colorbar.title`	+
	+ `plotly.graph_objects.surface`	+
	+ `plotly.graph_objects.surface.colorbar`	+
	+ `plotly.graph_objects.surface.colorbar.title`	+
	+ `plotly.graph_objects.surface.contours`	+
	+ `plotly.graph_objects.surface.contours.x`	+
	+ `plotly.graph_objects.surface.contours.y`	+
	+ `plotly.graph_objects.surface.contours.z`	+
	+ `plotly.graph_objects.surface.hoverlabel`	+
	+ `plotly.graph_objects.table`	+
	+ `plotly.graph_objects.table.cells`	+
	+ `plotly.graph_objects.table.header`	+
	+ `plotly.graph_objects.table.hoverlabel`	+
	+ `plotly.graph_objects.treemap`	+
	+ `plotly.graph_objects.treemap.hoverlabel`	+
	+ `plotly.graph_objects.treemap.marker`	+
	+ `plotly.graph_objects.treemap.marker.colorbar`	+
	+ `plotly.graph_objects.treemap.marker.colorbar.title`	+
	+ `plotly.graph_objects.treemap.pathbar`	+
	+ `plotly.graph_objects.violin`	+
	+ `plotly.graph_objects.violin.box`	+
	+ `plotly.graph_objects.violin.hoverlabel`	+
	+ `plotly.graph_objects.violin.marker`	+
	+ `plotly.graph_objects.violin.selected`	+
	+ `plotly.graph_objects.violin.unselected`	+
	+ `plotly.graph_objects.volume`	+
	+ `plotly.graph_objects.volume.caps`	+
	+ `plotly.graph_objects.volume.colorbar`	+
	+ `plotly.graph_objects.volume.colorbar.title`	+
	+ `plotly.graph_objects.volume.hoverlabel`	+
	+ `plotly.graph_objects.volume.slices`	+
	+ `plotly.graph_objects.waterfall`	+
	+ `plotly.graph_objects.waterfall.connector`	+
	+ `plotly.graph_objects.waterfall.decreasing`	+
	+ `plotly.graph_objects.waterfall.decreasing.marker`	+
	+ `plotly.graph_objects.waterfall.hoverlabel`	+
	+ `plotly.graph_objects.waterfall.increasing`	+
	+ `plotly.graph_objects.waterfall.increasing.marker`	+
	+ `plotly.graph_objects.waterfall.totals`	+
	+ `plotly.graph_objects.waterfall.totals.marker`	+
	+ `plotly.io`	+
	+ `plotly.io.base_renderers`	+
	+ `plotly.io.orca`	+
	+ `plotly.optional_imports`	+
	+ `plotly.serializers`	+
	+ `plotly.subplots`	+
	+ `plotly.tools`	+
	+ `plotly.utils`	+
	+ `plotly.validator_cache`	+
	+ `plotly.version`	+

plotly.graph_objects.Figure.add_traces¶

plotly.graph_objects.Figure¶

plotly.graph_objects.Figure.show¶

plotly.graph_objects.Figure.update_layout¶

plotly.graph_objects.Figure.update_traces¶

plotly¶

plotly.basedatatypes.BaseFigure¶

plotly.data package¶

Module contents¶

plotly.express.area¶

plotly.express.bar¶

plotly.express.bar_polar¶

plotly.express.box¶

plotly.express.choropleth¶

plotly.express.choropleth_mapbox¶

plotly.express.density_contour¶

plotly.express.density_heatmap¶

plotly.express.density_mapbox¶

plotly.express.funnel¶

plotly.express.funnel_area¶

plotly.express.histogram¶

plotly.express package¶

Submodules¶

plotly.express.colors module¶

plotly.express.data module¶

Module contents¶

plotly.express.imshow¶

plotly.express.line¶

plotly.express.line_3d¶

plotly.express.line_geo¶

plotly.express.line_mapbox¶

plotly.express.line_polar¶

plotly.express.line_ternary¶

plotly.express.parallel_categories¶

plotly.express.parallel_coordinates¶

plotly.express.pie¶

plotly.express.scatter¶

plotly.express.scatter_3d¶

plotly.express.scatter_geo¶

plotly.express.scatter_mapbox¶

plotly.express.scatter_matrix¶

plotly.express.scatter_polar¶

plotly.express.scatter_ternary¶

plotly.express.strip¶

plotly.express.sunburst¶

plotly.express.treemap¶

plotly.express.violin¶

plotly.figure_factory.create_2d_density¶

plotly.figure_factory.create_annotated_heatmap¶

plotly.figure_factory.create_bullet¶

plotly.figure_factory.create_candlestick¶

plotly.figure_factory.create_dendrogram¶

plotly.figure_factory.create_distplot¶

plotly.figure_factory.create_facet_grid¶

plotly.figure_factory.create_gantt¶

plotly.figure_factory.create_ohlc¶

plotly.figure_factory.create_quiver¶

plotly.figure_factory.create_scatterplotmatrix¶

plotly.figure_factory.create_streamline¶

plotly.figure_factory.create_table¶

plotly.figure_factory.create_ternary_contour¶

plotly.figure_factory.create_trisurf¶

plotly.figure_factory.create_violin¶

plotly.figure_factory package¶

Submodules¶

plotly.figure_factory.utils module¶

Module contents¶

plotly.graph_objects.Bar¶

plotly.graph_objects.bar¶

plotly.graph_objects.Barpolar¶

plotly.graph_objects.barpolar¶

plotly.graph_objects.Box¶

plotly.graph_objects.box¶

plotly.graph_objects.Candlestick¶

plotly.graph_objects.candlestick¶

plotly.graph_objects.Carpet¶

plotly.graph_objects.carpet¶

plotly.graph_objects.Choropleth¶

plotly.graph_objects.choropleth¶

plotly.graph_objects.Choroplethmapbox¶

`plotly.express`.area¶

`plotly.express`.bar¶

`plotly.express`.bar_polar¶

`plotly.express`.box¶

`plotly.express`.choropleth¶

`plotly.express`.choropleth_mapbox¶

`plotly.express`.density_contour¶

`plotly.express`.density_heatmap¶

`plotly.express`.density_mapbox¶

`plotly.express`.funnel¶

`plotly.express`.funnel_area¶

`plotly.express`.histogram¶

`plotly.express`.imshow¶

`plotly.express`.line¶

`plotly.express`.line_3d¶

`plotly.express`.line_geo¶

`plotly.express`.line_mapbox¶

`plotly.express`.line_polar¶

`plotly.express`.line_ternary¶

`plotly.express`.parallel_categories¶

`plotly.express`.parallel_coordinates¶

`plotly.express`.pie¶

`plotly.express`.scatter¶

`plotly.express`.scatter_3d¶

`plotly.express`.scatter_geo¶

`plotly.express`.scatter_mapbox¶

`plotly.express`.scatter_matrix¶

`plotly.express`.scatter_polar¶

`plotly.express`.scatter_ternary¶

`plotly.express`.strip¶

`plotly.express`.sunburst¶

`plotly.express`.treemap¶

`plotly.express`.violin¶

`plotly.figure_factory`.create_2d_density¶

`plotly.figure_factory`.create_annotated_heatmap¶

`plotly.figure_factory`.create_bullet¶

`plotly.figure_factory`.create_candlestick¶

`plotly.figure_factory`.create_dendrogram¶

`plotly.figure_factory`.create_distplot¶

`plotly.figure_factory`.create_facet_grid¶

`plotly.figure_factory`.create_gantt¶

`plotly.figure_factory`.create_ohlc¶

`plotly.figure_factory`.create_quiver¶

`plotly.figure_factory`.create_scatterplotmatrix¶

`plotly.figure_factory`.create_streamline¶

`plotly.figure_factory`.create_table¶

`plotly.figure_factory`.create_ternary_contour¶

`plotly.figure_factory`.create_trisurf¶

`plotly.figure_factory`.create_violin¶

`plotly.graph_objects`.Bar¶

`plotly.graph_objects`.bar¶

`plotly.graph_objects`.Barpolar¶

`plotly.graph_objects`.barpolar¶

`plotly.graph_objects`.Box¶

`plotly.graph_objects`.box¶

`plotly.graph_objects`.Candlestick¶

`plotly.graph_objects`.candlestick¶

`plotly.graph_objects`.Carpet¶

`plotly.graph_objects`.carpet¶

`plotly.graph_objects`.Choropleth¶

`plotly.graph_objects`.choropleth¶

`plotly.graph_objects`.Choroplethmapbox¶

`plotly.graph_objects`.choroplethmapbox¶

`plotly.graph_objects`.Cone¶

`plotly.graph_objects`.cone¶

`plotly.graph_objects`.Contour¶

`plotly.graph_objects`.contour¶

`plotly.graph_objects`.Contourcarpet¶

`plotly.graph_objects`.contourcarpet¶

`plotly.graph_objects`.Densitymapbox¶

`plotly.graph_objects`.densitymapbox¶

`plotly.graph_objects`.Figure¶

`plotly.graph_objects`.Funnel¶

`plotly.graph_objects`.funnel¶

`plotly.graph_objects`.Funnelarea¶

`plotly.graph_objects`.funnelarea¶

`plotly.graph_objects`.Heatmap¶

`plotly.graph_objects`.heatmap¶

`plotly.graph_objects`.Histogram¶

`plotly.graph_objects`.histogram¶