Slider Widget in Python/v3
Interacting with Plotly FigureWidgets using Sliders
Note: this page is part of the documentation for version 3 of Plotly.py, which is not the most recent version.
See our Version 4 Migration Guide for information about how to upgrade.
See our Version 4 Migration Guide for information about how to upgrade.
New to Plotly?¶
Plotly's Python library is free and open source! Get started by downloading the client and reading the primer.
You can set up Plotly to work in online or offline mode, or in jupyter notebooks.
We also have a quick-reference cheatsheet (new!) to help you get started!
Using a Single Slider to Set the Range¶
In [2]:
import plotly.graph_objs as go
import plotly.offline as py
import plotly
from ipywidgets import interactive, HBox, VBox, widgets, interact
py.init_notebook_mode()
# load fig
fig = plotly.plotly.get_figure("https://plotly.com/~jordanpeterson/889")
# find the range of the slider.
xmin, xmax = fig['layout']['xaxis']['range']
# create FigureWidget from fig
f = go.FigureWidget(data=fig.data, layout=fig.layout)
slider = widgets.FloatRangeSlider(
min=xmin,
max=xmax,
step=(xmax - xmin) / 1000.0,
readout=False,
description='Time')
slider.layout.width = '800px'
# our function that will modify the xaxis range
def update_range(y):
f.layout.xaxis.range = [y[0], y[1]]
# display the FigureWidget and slider with center justification
vb = VBox((f, interactive(update_range, y=slider)))
vb.layout.align_items = 'center'
vb
Using Two Sliders to Set the Range¶
In [ ]:
import plotly.graph_objs as go
import plotly.offline as py
import plotly
from ipywidgets import interactive, HBox, VBox
py.init_notebook_mode()
# load fig
fig = plotly.plotly.get_figure("https://plotly.com/~jordanpeterson/889")
# find the range of the slider.
xmin, xmax = fig['layout']['xaxis']['range']
# create FigureWidget from fig
f = go.FigureWidget(fig)
# our function that will modify the xaxis range
def update_range(start, end):
f.layout.xaxis.range = [start, end]
# display the FigureWidget and slider with center justification
vb = VBox((f, interactive(update_range,
start=(xmin, xmax, (xmax - xmin) / 1000.0),
end=(xmin, xmax, (xmax - xmin) / 1000.0))))
vb.layout.align_items = 'center'
vb
Sliders with 3d Plots¶
In [1]:
import plotly.graph_objs as go
import plotly.offline as py
import numpy as np
from ipywidgets import interactive, HBox, VBox
py.init_notebook_mode()
x = y = np.arange(-5, 5, 0.1)
yt = x[:, np.newaxis]
z = np.cos(x * yt) + np.sin(x * yt) * 2
f = go.FigureWidget(
data=[
go.Surface(z=z, x=x, y=y,
colorscale='Viridis')],
layout=go.Layout(scene=go.layout.Scene(
camera=go.layout.scene.Camera(
up=dict(x=0, y=0, z=1),
center=dict(x=0, y=0, z=0),
eye=dict(x=1.25, y=1.25, z=1.25))
))
)
def update_z(frequency):
f.data[0].z = np.cos(x * yt * frequency / 10.0) + np.sin(x * yt * frequency / 10.0) * 2
freq_slider = interactive(update_z, frequency=(1, 50, 0.1))
vb = VBox((f, freq_slider))
vb.layout.align_items = 'center'
vb
Reference¶
See these Jupyter notebooks for even more FigureWidget examples.
In [15]:
help(go.FigureWidget)
Help on class FigureWidget in module plotly.graph_objs._figurewidget:
class FigureWidget(plotly.basewidget.BaseFigureWidget)
| Method resolution order:
| FigureWidget
| plotly.basewidget.BaseFigureWidget
| plotly.basedatatypes.BaseFigure
| ipywidgets.widgets.domwidget.DOMWidget
| ipywidgets.widgets.widget.Widget
| ipywidgets.widgets.widget.LoggingHasTraits
| traitlets.traitlets.HasTraits
| traitlets.traitlets.HasDescriptors
| __builtin__.object
|
| Methods defined here:
|
| __init__(self, data=None, layout=None, frames=None)
| Create a new FigureWidget instance
|
| Parameters
| ----------
| data
| The 'data' property is a tuple of trace instances
| that may be specified as:
| - A list or tuple of trace instances
| (e.g. [Scatter(...), Bar(...)])
| - A list or tuple of dicts of string/value properties where:
| - The 'type' property specifies the trace type
| One of: ['area', 'bar', 'box', 'candlestick', 'carpet',
| 'choropleth', 'cone', 'contour',
| 'contourcarpet', 'heatmap', 'heatmapgl',
| 'histogram', 'histogram2d',
| 'histogram2dcontour', 'mesh3d', 'ohlc',
| 'parcoords', 'pie', 'pointcloud', 'sankey',
| 'scatter', 'scatter3d', 'scattercarpet',
| 'scattergeo', 'scattergl', 'scattermapbox',
| 'scatterpolar', 'scatterpolargl',
| 'scatterternary', 'splom', 'surface', 'table',
| 'violin']
|
| - All remaining properties are passed to the constructor of
| the specified trace type
|
| (e.g. [{'type': 'scatter', ...}, {'type': 'bar, ...}])
| layout
| The 'layout' property is an instance of Layout
| that may be specified as:
| - An instance of plotly.graph_objs.Layout
| - A dict of string/value properties that will be passed
| to the Layout constructor
|
| Supported dict properties:
|
| angularaxis
| plotly.graph_objs.layout.AngularAxis instance
| or dict with compatible properties
| annotations
| plotly.graph_objs.layout.Annotation instance or
| dict with compatible properties
| 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.
| bargap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| bargroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| 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.
| barnorm
| Sets the normalization for bar traces on the
| graph. With *fraction*, the value of each bar
| is divide by the sum of the values at the
| location coordinate. With *percent*, the
| results form *fraction* are presented in
| percents.
| boxgap
| Sets the gap (in plot fraction) between boxes
| of adjacent location coordinates.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes
| of the same location coordinate.
| 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.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout
| the plot.
| colorway
| Sets the default trace colors.
| 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.
| direction
| For polar plots only. Sets the direction
| corresponding to positive angles.
| 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.
| font
| Sets the global font. Note that fonts used in
| traces and other layout components inherit from
| the global font.
| geo
| plotly.graph_objs.layout.Geo instance or dict
| with compatible properties
| grid
| plotly.graph_objs.layout.Grid instance or dict
| with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
|
| hiddenlabelssrc
| Sets the source reference on plot.ly for
| hiddenlabels .
| 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 plotly service (at
| https://plotly.com or on-premise).
| 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.
| hoverlabel
| plotly.graph_objs.layout.Hoverlabel instance or
| dict with compatible properties
| hovermode
| Determines the mode of hover interactions.
| images
| plotly.graph_objs.layout.Image instance or dict
| with compatible properties
| legend
| plotly.graph_objs.layout.Legend instance or
| dict with compatible properties
| mapbox
| plotly.graph_objs.layout.Mapbox instance or
| dict with compatible properties
| margin
| plotly.graph_objs.layout.Margin instance or
| dict with compatible properties
| orientation
| For polar plots only. Rotates the entire polar
| by the given angle.
| paper_bgcolor
| Sets the color of paper where the graph is
| drawn.
| plot_bgcolor
| Sets the color of plotting area in-between x
| and y axes.
| polar
| plotly.graph_objs.layout.Polar instance or dict
| with compatible properties
| radialaxis
| plotly.graph_objs.layout.RadialAxis instance or
| dict with compatible properties
| scene
| plotly.graph_objs.layout.Scene instance or dict
| with compatible properties
| 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.
| 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.
| shapes
| plotly.graph_objs.layout.Shape instance or dict
| with compatible properties
| showlegend
| Determines whether or not a legend is drawn.
| sliders
| plotly.graph_objs.layout.Slider instance or
| dict with compatible properties
| 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.
| ternary
| plotly.graph_objs.layout.Ternary instance or
| dict with compatible properties
| title
| Sets the plot's title.
| titlefont
| Sets the title font.
| updatemenus
| plotly.graph_objs.layout.Updatemenu instance or
| dict with compatible properties
| violingap
| Sets the gap (in plot fraction) between violins
| of adjacent location coordinates.
| violingroupgap
| Sets the gap (in plot fraction) between violins
| of the same location coordinate.
| 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.
| width
| Sets the plot's width (in px).
| xaxis
| plotly.graph_objs.layout.XAxis instance or dict
| with compatible properties
| yaxis
| plotly.graph_objs.layout.YAxis instance or dict
| with compatible properties
| frames
| The 'frames' property is a tuple of instances of
| Frame that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.Frame
| - A list or tuple of dicts of string/value properties that
| will be passed to the Frame constructor
|
| Supported dict properties:
|
| 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.
| data
| A list of traces this frame modifies. The
| format is identical to the normal trace
| definition.
| group
| An identifier that specifies the group to which
| the frame belongs, used by animate to select a
| subset of frames.
| layout
| Layout properties which this frame modifies.
| The format is identical to the normal layout
| definition.
| name
| A label by which to identify the frame
| traces
| A list of trace indices that identify the
| respective traces in the data attribute
|
| add_area(self, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, name=None, opacity=None, r=None, rsrc=None, selectedpoints=None, showlegend=None, stream=None, t=None, tsrc=None, uid=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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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 plot.ly 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_objs.area.Marker instance or dict with
| compatible properties
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| For legacy polar chart only.Please switch to
| *scatterpolar* trace type.Sets the radial coordinates.
| rsrc
| Sets the source reference on plot.ly for r .
| 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_objs.area.Stream instance or dict with
| compatible properties
| t
| For legacy polar chart only.Please switch to
| *scatterpolar* trace type.Sets the angular coordinates.
| tsrc
| Sets the source reference on plot.ly for t .
| uid
|
| visible
| Determines whether or not this 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
| -------
| Area
|
| add_bar(self, 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, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, legendgroup=None, marker=None, name=None, offset=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, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, tsrc=None, uid=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, **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
| ----------
| 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 plot.ly 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 plot.ly 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_objs.bar.ErrorX instance or dict with
| compatible properties
| error_y
| plotly.graph_objs.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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.bar.Hoverlabel instance or dict with
| compatible properties
| 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 plot.ly 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 plot.ly for ids .
| 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_objs.bar.Marker instance or dict with
| compatible properties
| 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.
| offsetsrc
| Sets the source reference on plot.ly 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
| For legacy polar chart only.Please switch to
| *scatterpolar* trace type.Sets the radial coordinates.
| rsrc
| Sets the source reference on plot.ly for r .
| selected
| plotly.graph_objs.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_objs.bar.Stream instance or dict with
| compatible properties
| t
| For legacy polar chart only.Please switch to
| *scatterpolar* trace type.Sets the angular coordinates.
| 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 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). *auto*
| positions `text` inside or outside so that `text` size
| is maximized.
| textpositionsrc
| Sets the source reference on plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| tsrc
| Sets the source reference on plot.ly for t .
| uid
|
| unselected
| plotly.graph_objs.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 plot.ly 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 plot.ly 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 plot.ly 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`
|
| Returns
| -------
| Bar
|
| add_box(self, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, ids=None, idssrc=None, jitter=None, legendgroup=None, line=None, marker=None, name=None, notched=None, notchwidth=None, opacity=None, orientation=None, pointpos=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, unselected=None, visible=None, whiskerwidth=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, **kwargs)
| Add a new Box trace
|
| In vertical (horizontal) box plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| box per distinct x (y) value is drawn If no `x` (`y`) {array}
| is provided, a single box is drawn. That box position is then
| positioned with with `name` or with `x0` (`y0`) if provided.
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2) is marked by a line inside the box. By
| default, the whiskers correspond to the box' edges +/- 1.5
| times the interquartile range (IQR = Q3-Q1), see *boxpoints*
| for other options.
|
| Parameters
| ----------
| 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.
| 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
| customdata
| Assigns extra data each datum. This 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.box.Hoverlabel instance or dict with
| compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| ids
| Assigns id labels to 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 plot.ly 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_objs.box.Line instance or dict with
| compatible properties
| marker
| plotly.graph_objs.box.Marker instance or dict with
| compatible properties
| 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 should be drawn.
| 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).
| 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
| selected
| plotly.graph_objs.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_objs.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 plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.box.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).
| 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 sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate of the box. 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 plot.ly for x .
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate of the box. 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 plot.ly 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`
|
| Returns
| -------
| Box
|
| add_candlestick(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, increasing=None, legendgroup=None, line=None, low=None, lowsrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, row=None, col=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 plot.ly 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 plot.ly for customdata .
| decreasing
| plotly.graph_objs.candlestick.Decreasing instance or
| dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.candlestick.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 plot.ly for ids .
| increasing
| plotly.graph_objs.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_objs.candlestick.Line instance or dict
| with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on plot.ly for low .
| 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 plot.ly 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_objs.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 plot.ly for text .
| uid
|
| visible
| Determines whether or not this 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 plot.ly 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`
|
| Returns
| -------
| Candlestick
|
| add_carpet(self, 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, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, name=None, opacity=None, selectedpoints=None, showlegend=None, stream=None, uid=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, row=None, col=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_objs.carpet.Aaxis instance or dict with
| compatible properties
| asrc
| Sets the source reference on plot.ly 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_objs.carpet.Baxis instance or dict with
| compatible properties
| bsrc
| Sets the source reference on plot.ly for b .
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `scattercontour` 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 plot.ly 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
| hoverinfo
| Determines which trace information appear on hover. 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.carpet.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 plot.ly 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.
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| 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_objs.carpet.Stream instance or dict with
| compatible properties
| uid
|
| visible
| Determines whether or not this 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 plot.ly 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 plot.ly 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`
|
| Returns
| -------
| Carpet
|
| add_choropleth(self, autocolorscale=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, geo=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, locationmode=None, locations=None, locationssrc=None, marker=None, name=None, opacity=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, unselected=None, visible=None, z=None, zauto=None, zmax=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 or not the colorscale is picked
| using the sign of the input z values.
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| customdata
| Assigns extra data each datum. This 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 plot.ly for customdata .
| 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.
| hoverinfo
| Determines which trace information appear on hover. 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.choropleth.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 plot.ly 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.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on plot.ly for locations .
| marker
| plotly.graph_objs.choropleth.Marker instance or dict
| with compatible properties
| 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 colorscale.
| selected
| plotly.graph_objs.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_objs.choropleth.Stream instance or dict
| with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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 the whether or not the color domain is
| computed with respect to the input data.
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Choropleth
|
| add_cone(self, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmin=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, lighting=None, lightposition=None, name=None, opacity=None, reversescale=None, scene=None, selectedpoints=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uid=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
| Has an effect only if `color` is set to a numerical
| array. 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
| Has an effect only if `color` is set to a numerical
| array and `cmin`, `cmax` are set by the user. In this
| case, it controls whether the range of colors in
| `colorscale` is mapped to the range of values in the
| `color` array (`cauto: true`), or the `cmin`/`cmax`
| values (`cauto: false`). Defaults to `false` when
| `cmin`, `cmax` are set by the user.
| cmax
| Has an effect only if `color` is set to a numerical
| array. Sets the upper bound of the color domain. Value
| should be associated to the `color` array index, and if
| set, `cmin` must be set as well.
| cmin
| Has an effect only if `color` is set to a numerical
| array. Sets the lower bound of the color domain. Value
| should be associated to the `color` array index, and if
| set, `cmax` must be set as well.
| colorbar
| plotly.graph_objs.cone.ColorBar instance or dict with
| compatible properties
| colorscale
| Sets the colorscale and only has an effect if `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 `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Greys, YlGnBu, Greens,
| YlOrRd, Bluered, RdBu, Reds, Blues, Picnic, Rainbow,
| Portland, Jet, Hot, 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.cone.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 plot.ly 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_objs.cone.Lighting instance or dict with
| compatible properties
| lightposition
| plotly.graph_objs.cone.Lightposition instance or dict
| with compatible properties
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface.
| reversescale
| Has an effect only if `color` is set to a numerical
| array. Reverses the color mapping 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.
| 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.
| 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_objs.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 plot.ly for text .
| u
| Sets the x components of the vector field.
| uid
|
| usrc
| Sets the source reference on plot.ly 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 plot.ly for v .
| w
| Sets the z components of the vector field.
| wsrc
| Sets the source reference on plot.ly for w .
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xsrc
| Sets the source reference on plot.ly for x .
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| ysrc
| Sets the source reference on plot.ly for y .
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Cone
|
| add_contour(self, autocolorscale=None, autocontour=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, ids=None, idssrc=None, legendgroup=None, line=None, name=None, ncontours=None, opacity=None, reversescale=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=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, zmin=None, zsrc=None, row=None, col=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 array} 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 or not the colorscale is picked
| using the sign of the input z values.
| 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`.
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| plotly.graph_objs.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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.contour.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 plot.ly 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_objs.contour.Line instance or dict with
| compatible properties
| 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 colorscale.
| 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_objs.contour.Stream instance or dict with
| compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on plot.ly for text .
| transpose
| Transposes the z data.
| uid
|
| visible
| Determines whether or not this 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 plot.ly 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 plot.ly 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 the whether or not the color domain is
| computed with respect to the input data.
| 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-format/blob/maste
| r/README.md#locale_format
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Contour
|
| add_contourcarpet(self, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, line=None, name=None, ncontours=None, opacity=None, reversescale=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmin=None, zsrc=None, row=None, col=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 plot.ly 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 or not the colorscale is picked
| using the sign of the input z values.
| 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 plot.ly 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
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| contours
| plotly.graph_objs.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 plot.ly 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.
| hoverinfo
| Determines which trace information appear on hover. 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.contourcarpet.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 plot.ly 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_objs.contourcarpet.Line instance or dict
| with compatible properties
| 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 colorscale.
| 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_objs.contourcarpet.Stream instance or dict
| with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on plot.ly for text .
| transpose
| Transposes the z data.
| uid
|
| visible
| Determines whether or not this 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 the whether or not the color domain is
| computed with respect to the input data.
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Contourcarpet
|
| add_heatmap(self, autocolorscale=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, name=None, opacity=None, reversescale=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=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, zmin=None, zsmooth=None, zsrc=None, row=None, col=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 array} of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a {2D array}, 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 {array}, the x and
| y coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| autocolorscale
| Determines whether or not the colorscale is picked
| using the sign of the input z values.
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| customdata
| Assigns extra data each datum. This 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.heatmap.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 plot.ly 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.
| 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 colorscale.
| 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_objs.heatmap.Stream instance or dict with
| compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on plot.ly for text .
| transpose
| Transposes the z data.
| uid
|
| visible
| Determines whether or not this 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 plot.ly 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 plot.ly 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 the whether or not the color domain is
| computed with respect to the input data.
| 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-format/blob/maste
| r/README.md#locale_format
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Heatmap
|
| add_heatmapgl(self, autocolorscale=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, name=None, opacity=None, reversescale=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=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, zmin=None, zsrc=None, row=None, col=None, **kwargs)
| Add a new Heatmapgl trace
|
| WebGL version of the heatmap trace type.
|
| Parameters
| ----------
| autocolorscale
| Determines whether or not the colorscale is picked
| using the sign of the input z values.
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| customdata
| Assigns extra data each datum. This 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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 plot.ly 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.
| 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 colorscale.
| 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_objs.heatmapgl.Stream instance or dict
| with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on plot.ly for text .
| transpose
| Transposes the z data.
| uid
|
| visible
| Determines whether or not this 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 plot.ly 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 plot.ly 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 the whether or not the color domain is
| computed with respect to the input data.
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Heatmapgl
|
| add_histogram(self, autobinx=None, autobiny=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, name=None, nbinsx=None, nbinsy=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=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, **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
| ----------
| autobinx
| Determines whether or not the x axis bin attributes are
| picked by an algorithm. Note that this should be set to
| false if you want to manually set the number of bins
| using the attributes in xbins.
| autobiny
| Determines whether or not the y axis bin attributes are
| picked by an algorithm. Note that this should be set to
| false if you want to manually set the number of bins
| using the attributes in ybins.
| cumulative
| plotly.graph_objs.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 plot.ly for customdata .
| error_x
| plotly.graph_objs.histogram.ErrorX instance or dict
| with compatible properties
| error_y
| plotly.graph_objs.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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.histogram.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 plot.ly 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_objs.histogram.Marker instance or dict
| with compatible properties
| 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.
| 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.
| 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_objs.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_objs.histogram.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 plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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_objs.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 plot.ly 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_objs.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 plot.ly 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`
|
| Returns
| -------
| Histogram
|
| add_histogram2d(self, autobinx=None, autobiny=None, autocolorscale=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, uid=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xgap=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ygap=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=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
| Determines whether or not the x axis bin attributes are
| picked by an algorithm. Note that this should be set to
| false if you want to manually set the number of bins
| using the attributes in xbins.
| autobiny
| Determines whether or not the y axis bin attributes are
| picked by an algorithm. Note that this should be set to
| false if you want to manually set the number of bins
| using the attributes in ybins.
| autocolorscale
| Determines whether or not the colorscale is picked
| using the sign of the input z values.
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| customdata
| Assigns extra data each datum. This 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.histogram2d.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 plot.ly 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_objs.histogram2d.Marker instance or dict
| with compatible properties
| 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.
| 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.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the colorscale.
| 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_objs.histogram2d.Stream instance or dict
| with compatible properties
| uid
|
| visible
| Determines whether or not this 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_objs.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 plot.ly 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_objs.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 plot.ly for y .
| z
| Sets the aggregation data.
| zauto
| Determines the whether or not the color domain is
| computed with respect to the input data.
| 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-format/blob/maste
| r/README.md#locale_format
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Histogram2d
|
| add_histogram2dcontour(self, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, uid=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmin=None, zsrc=None, row=None, col=None, **kwargs)
| Add a new Histogram2dContour trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a contour plot.
|
| Parameters
| ----------
| autobinx
| Determines whether or not the x axis bin attributes are
| picked by an algorithm. Note that this should be set to
| false if you want to manually set the number of bins
| using the attributes in xbins.
| autobiny
| Determines whether or not the y axis bin attributes are
| picked by an algorithm. Note that this should be set to
| false if you want to manually set the number of bins
| using the attributes in ybins.
| autocolorscale
| Determines whether or not the colorscale is picked
| using the sign of the input z values.
| 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`.
| colorbar
| plotly.graph_objs.histogram2dcontour.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 z space, use zmin and zmax
| contours
| plotly.graph_objs.histogram2dcontour.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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.histogram2dcontour.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 plot.ly 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_objs.histogram2dcontour.Line instance or
| dict with compatible properties
| marker
| plotly.graph_objs.histogram2dcontour.Marker instance or
| dict with compatible properties
| 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.
| 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.
| 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 colorscale.
| 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_objs.histogram2dcontour.Stream instance or
| dict with compatible properties
| uid
|
| visible
| Determines whether or not this 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_objs.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 plot.ly 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_objs.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 plot.ly for y .
| z
| Sets the aggregation data.
| zauto
| Determines the whether or not the color domain is
| computed with respect to the input data.
| 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-format/blob/maste
| r/README.md#locale_format
| zmax
| Sets the upper bound of color domain.
| zmin
| Sets the lower bound of color domain.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Histogram2dContour
|
| add_mesh3d(self, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmin=None, color=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, i=None, ids=None, idssrc=None, intensity=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legendgroup=None, lighting=None, lightposition=None, name=None, opacity=None, reversescale=None, scene=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=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
| Has an effect only if `color` is set to a numerical
| array. 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
| Has an effect only if `color` is set to a numerical
| array and `cmin`, `cmax` are set by the user. In this
| case, it controls whether the range of colors in
| `colorscale` is mapped to the range of values in the
| `color` array (`cauto: true`), or the `cmin`/`cmax`
| values (`cauto: false`). Defaults to `false` when
| `cmin`, `cmax` are set by the user.
| cmax
| Has an effect only if `color` is set to a numerical
| array. Sets the upper bound of the color domain. Value
| should be associated to the `color` array index, and if
| set, `cmin` must be set as well.
| cmin
| Has an effect only if `color` is set to a numerical
| array. Sets the lower bound of the color domain. Value
| should be associated to the `color` array index, and if
| set, `cmax` must be set as well.
| color
| Sets the color of the whole mesh
| colorbar
| plotly.graph_objs.mesh3d.ColorBar instance or dict with
| compatible properties
| colorscale
| Sets the colorscale and only has an effect if `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 `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Greys, YlGnBu, Greens,
| YlOrRd, Bluered, RdBu, Reds, Blues, Picnic, Rainbow,
| Portland, Jet, Hot, Blackbody, Earth, Electric,
| Viridis, Cividis
| contour
| plotly.graph_objs.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 plot.ly 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.mesh3d.Hoverlabel instance or dict
| with compatible properties
| 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 plot.ly for ids .
| intensity
| Sets the vertex intensity values, used for plotting
| fields on meshes
| intensitysrc
| Sets the source reference on plot.ly for intensity .
| isrc
| Sets the source reference on plot.ly 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 plot.ly 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 plot.ly 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_objs.mesh3d.Lighting instance or dict with
| compatible properties
| lightposition
| plotly.graph_objs.mesh3d.Lightposition instance or dict
| with compatible properties
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface.
| reversescale
| Has an effect only if `color` is set to a numerical
| array. Reverses the color mapping 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.
| 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_objs.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 plot.ly for text .
| uid
|
| vertexcolor
| Sets the color of each vertex Overrides *color*.
| vertexcolorsrc
| Sets the source reference on plot.ly 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 plot.ly 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 plot.ly 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 plot.ly 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
| -------
| Mesh3d
|
| add_ohlc(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, increasing=None, legendgroup=None, line=None, low=None, lowsrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, visible=None, x=None, xaxis=None, xcalendar=None, xsrc=None, yaxis=None, row=None, col=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 plot.ly 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 plot.ly for customdata .
| decreasing
| plotly.graph_objs.ohlc.Decreasing instance or dict with
| compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.ohlc.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 plot.ly for ids .
| increasing
| plotly.graph_objs.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_objs.ohlc.Line instance or dict with
| compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on plot.ly for low .
| 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 plot.ly 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_objs.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 plot.ly for text .
| tickwidth
| Sets the width of the open/close tick marks relative to
| the *x* minimal interval.
| uid
|
| visible
| Determines whether or not this 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 plot.ly 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`
|
| Returns
| -------
| Ohlc
|
| add_parcoords(self, customdata=None, customdatasrc=None, dimensions=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, labelfont=None, legendgroup=None, line=None, name=None, opacity=None, rangefont=None, selectedpoints=None, showlegend=None, stream=None, tickfont=None, uid=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 plot.ly for customdata .
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| domain
| plotly.graph_objs.parcoords.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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.parcoords.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 plot.ly for ids .
| labelfont
| Sets the font for the `dimension` 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.
| line
| plotly.graph_objs.parcoords.Line instance or dict with
| compatible properties
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| rangefont
| Sets the font for the `dimension` range values.
| 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_objs.parcoords.Stream instance or dict
| with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
|
| visible
| Determines whether or not this 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
| -------
| Parcoords
|
| add_pie(self, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legendgroup=None, marker=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, selectedpoints=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, uid=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
| ----------
| customdata
| Assigns extra data each datum. This 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 plot.ly 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_objs.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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.pie.Hoverlabel instance or dict with
| compatible properties
| 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 plot.ly 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 plot.ly for ids .
| insidetextfont
| Sets the font used for `textinfo` lying inside the pie.
| 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 plot.ly 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_objs.pie.Marker instance or dict with
| compatible properties
| 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
| pie.
| 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 plot.ly for pull .
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pies 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.
| 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.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| plotly.graph_objs.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 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 plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| uid
|
| values
| Sets the values of the sectors of this pie chart. If
| omitted, we count occurrences of each label.
| valuessrc
| Sets the source reference on plot.ly 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
| -------
| Pie
|
| add_pointcloud(self, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legendgroup=None, marker=None, name=None, opacity=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=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, **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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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 plot.ly 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 plot.ly 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_objs.pointcloud.Marker instance or dict
| with compatible properties
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| 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_objs.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 plot.ly for text .
| uid
|
| visible
| Determines whether or not this 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 plot.ly for xbounds .
| xsrc
| Sets the source reference on plot.ly 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 plot.ly 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 plot.ly for ybounds .
| ysrc
| Sets the source reference on plot.ly 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`
|
| Returns
| -------
| Pointcloud
|
| add_sankey(self, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, link=None, name=None, node=None, opacity=None, orientation=None, selectedpoints=None, showlegend=None, stream=None, textfont=None, uid=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 plot.ly for customdata .
| domain
| plotly.graph_objs.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.
| hoverinfosrc
| Sets the source reference on plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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 plot.ly 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.
| link
| The links of the Sankey plot.
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| opacity
| Sets the opacity of the trace.
| 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.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| plotly.graph_objs.sankey.Stream instance or dict with
| compatible properties
| textfont
| Sets the font for node labels
| uid
|
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-language which is similar to those of Python. See
| https://github.com/d3/d3-format/blob/master/README.md#l
| ocale_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
| -------
| Sankey
|
| add_scatter(self, cliponaxis=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, hoveron=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, mode=None, name=None, opacity=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, t=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, tsrc=None, uid=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, **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 plot.ly 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_objs.scatter.ErrorX instance or dict with
| compatible properties
| error_y
| plotly.graph_objs.scatter.ErrorY instance or dict with
| compatible properties
| fill
| Sets the area to fill with a solid color. 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.
| 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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*.
| 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 plot.ly 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 plot.ly 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_objs.scatter.Line instance or dict with
| compatible properties
| marker
| plotly.graph_objs.scatter.Marker instance or dict with
| compatible properties
| 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, 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
| For legacy polar chart only.Please switch to
| *scatterpolar* trace type.Sets the radial coordinates.
| rsrc
| Sets the source reference on plot.ly for r .
| selected
| plotly.graph_objs.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.
| stream
| plotly.graph_objs.scatter.Stream instance or dict with
| compatible properties
| t
| For legacy polar chart only.Please switch to
| *scatterpolar* trace type.Sets the angular coordinates.
| 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 plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| tsrc
| Sets the source reference on plot.ly for t .
| uid
|
| unselected
| plotly.graph_objs.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 plot.ly 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 plot.ly 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`
|
| Returns
| -------
| Scatter
|
| add_scatter3d(self, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, mode=None, name=None, opacity=None, projection=None, scene=None, selectedpoints=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, uid=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 plot.ly for customdata .
| error_x
| plotly.graph_objs.scatter3d.ErrorX instance or dict
| with compatible properties
| error_y
| plotly.graph_objs.scatter3d.ErrorY instance or dict
| with compatible properties
| error_z
| plotly.graph_objs.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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.scatter3d.Hoverlabel instance or dict
| with compatible properties
| 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 plot.ly 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 plot.ly 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_objs.scatter3d.Line instance or dict with
| compatible properties
| marker
| plotly.graph_objs.scatter3d.Marker instance or dict
| with compatible properties
| 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, 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_objs.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.
| 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_objs.scatter3d.Stream instance or dict
| with compatible properties
| surfaceaxis
| If *-1*, the scatter points are not fill with a surface
| If *0*, *1*, *2*, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a *text*
| flag and *hovertext* is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| uid
|
| visible
| Determines whether or not this 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 plot.ly for x .
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ysrc
| Sets the source reference on plot.ly for y .
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Scatter3d
|
| add_scattercarpet(self, 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, ids=None, idssrc=None, legendgroup=None, line=None, marker=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, uid=None, unselected=None, visible=None, xaxis=None, yaxis=None, row=None, col=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 quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on plot.ly for a .
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on plot.ly for b .
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `scattercontour` 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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*.
| ids
| Assigns id labels to 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 plot.ly 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_objs.scattercarpet.Line instance or dict
| with compatible properties
| marker
| plotly.graph_objs.scattercarpet.Marker instance or dict
| with compatible properties
| 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, 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_objs.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_objs.scattercarpet.Stream instance or dict
| with compatible properties
| 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).
| 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 plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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`
|
| Returns
| -------
| Scattercarpet
|
| add_scattergeo(self, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, geo=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=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, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, uid=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 plot.ly 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.
| 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.
| hoverinfo
| Determines which trace information appear on hover. 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.scattergeo.Hoverlabel instance or
| dict with compatible properties
| 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 plot.ly 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 plot.ly for ids .
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on plot.ly 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_objs.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.
| 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 plot.ly for locations .
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on plot.ly for lon .
| marker
| plotly.graph_objs.scattergeo.Marker instance or dict
| with compatible properties
| 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, 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_objs.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_objs.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 plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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
| -------
| Scattergeo
|
| add_scattergl(self, 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, hoveron=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=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, **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 plot.ly 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_objs.scattergl.ErrorX instance or dict
| with compatible properties
| error_y
| plotly.graph_objs.scattergl.ErrorY instance or dict
| with compatible properties
| fill
| Sets the area to fill with a solid color. 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.
| 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.scattergl.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*.
| ids
| Assigns id labels to 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 plot.ly 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_objs.scattergl.Line instance or dict with
| compatible properties
| marker
| plotly.graph_objs.scattergl.Marker instance or dict
| with compatible properties
| 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_objs.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_objs.scattergl.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 plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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 plot.ly 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 plot.ly 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`
|
| Returns
| -------
| Scattergl
|
| add_scattermapbox(self, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legendgroup=None, line=None, lon=None, lonsrc=None, marker=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, uid=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
| ----------
| 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.scattermapbox.Hoverlabel instance or
| dict with compatible properties
| 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 plot.ly 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 plot.ly for ids .
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on plot.ly 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_objs.scattermapbox.Line instance or dict
| with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on plot.ly for lon .
| marker
| plotly.graph_objs.scattermapbox.Marker instance or dict
| with compatible properties
| 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_objs.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_objs.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. 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 plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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
| -------
| Scattermapbox
|
| add_scatterpolar(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, mode=None, name=None, opacity=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, theta=None, thetasrc=None, thetaunit=None, uid=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 plot.ly for customdata .
| 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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*.
| 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 plot.ly 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 plot.ly 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_objs.scatterpolar.Line instance or dict
| with compatible properties
| marker
| plotly.graph_objs.scatterpolar.Marker instance or dict
| with compatible properties
| 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, 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
| rsrc
| Sets the source reference on plot.ly for r .
| selected
| plotly.graph_objs.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_objs.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 plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| theta
| Sets the angular coordinates
| thetasrc
| Sets the source reference on plot.ly for theta .
| thetaunit
| Sets the unit of input *theta* values. Has an effect
| only when on *linear* angular axes.
| uid
|
| unselected
| plotly.graph_objs.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
| -------
| Scatterpolar
|
| add_scatterpolargl(self, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, mode=None, name=None, opacity=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, thetasrc=None, thetaunit=None, uid=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 plot.ly for customdata .
| fill
| Sets the area to fill with a solid color. 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.
| 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.scatterpolargl.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*.
| ids
| Assigns id labels to 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 plot.ly 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_objs.scatterpolargl.Line instance or dict
| with compatible properties
| marker
| plotly.graph_objs.scatterpolargl.Marker instance or
| dict with compatible properties
| 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, 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
| rsrc
| Sets the source reference on plot.ly for r .
| selected
| plotly.graph_objs.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_objs.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.
| textsrc
| Sets the source reference on plot.ly for text .
| theta
| Sets the angular coordinates
| thetasrc
| Sets the source reference on plot.ly for theta .
| thetaunit
| Sets the unit of input *theta* values. Has an effect
| only when on *linear* angular axes.
| uid
|
| unselected
| plotly.graph_objs.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
| -------
| Scatterpolargl
|
| add_scatterternary(self, 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, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=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, uid=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<i>.sum`.
| asrc
| Sets the source reference on plot.ly for a .
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on plot.ly for b .
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on plot.ly 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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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*.
| 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 plot.ly 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 plot.ly 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_objs.scatterternary.Line instance or dict
| with compatible properties
| marker
| plotly.graph_objs.scatterternary.Marker instance or
| dict with compatible properties
| 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, 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_objs.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_objs.scatterternary.Stream instance or
| dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If *ternary* (the default
| value), the data refer to `layout.ternary`. If
| *ternary2*, the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a *text* flag and
| *hovertext* is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on plot.ly for textposition
| .
| textsrc
| Sets the source reference on plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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
| -------
| Scatterternary
|
| add_splom(self, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, marker=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=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 plot.ly for customdata .
| diagonal
| plotly.graph_objs.splom.Diagonal instance or dict with
| compatible properties
| dimensions
| plotly.graph_objs.splom.Dimension 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.splom.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 plot.ly 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_objs.splom.Marker instance or dict with
| compatible properties
| 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_objs.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_objs.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 plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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 this splom
| trace. By default, a splom will match the first N xaxes
| where N is the number of input dimensions.
| yaxes
| Sets the list of y axes corresponding to this splom
| trace. By default, a splom will match the first N yaxes
| where N is the number of input dimensions.
| 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
| -------
| Splom
|
| add_surface(self, autocolorscale=None, cauto=None, cmax=None, cmin=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legendgroup=None, lighting=None, lightposition=None, name=None, opacity=None, reversescale=None, scene=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=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 array}. Coordinates in `x` and
| `y` can either be 1D {arrays} or {2D arrays} (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 array}, where its bounds can be controlled
| using `cmin` and `cmax`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether or not the colorscale is picked
| using the sign of the input z values.
| cauto
| Determines the whether or not the color domain is
| computed with respect to the input data.
| cmax
| Sets the upper bound of color domain.
| cmin
| Sets the lower bound of color domain.
| colorbar
| plotly.graph_objs.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 z space, use zmin and zmax
| contours
| plotly.graph_objs.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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.surface.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 plot.ly 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_objs.surface.Lighting instance or dict
| with compatible properties
| lightposition
| plotly.graph_objs.surface.Lightposition instance or
| dict with compatible properties
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface.
| reversescale
| Reverses the colorscale.
| 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.
| 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_objs.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 plot.ly 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 plot.ly for text .
| uid
|
| visible
| Determines whether or not this 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 plot.ly for x .
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ysrc
| Sets the source reference on plot.ly for y .
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zsrc
| Sets the source reference on plot.ly 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
| -------
| Surface
|
| add_table(self, 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, legendgroup=None, name=None, opacity=None, selectedpoints=None, showlegend=None, stream=None, uid=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_objs.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 plot.ly 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 plot.ly 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 plot.ly for customdata .
| domain
| plotly.graph_objs.table.Domain instance or dict with
| compatible properties
| header
| plotly.graph_objs.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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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 plot.ly 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.
| name
| Sets the trace name. The trace name appear as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| 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_objs.table.Stream instance or dict with
| compatible properties
| uid
|
| visible
| Determines whether or not this 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
| -------
| Table
|
| add_violin(self, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, ids=None, idssrc=None, jitter=None, legendgroup=None, line=None, marker=None, meanline=None, name=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, unselected=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, y=None, y0=None, yaxis=None, ysrc=None, row=None, col=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`)
| {array} is provided, a single violin is drawn. That violin
| position is then positioned with with `name` or with `x0`
| (`y0`) if provided.
|
| Parameters
| ----------
| 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_objs.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 plot.ly 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 plot.ly for hoverinfo .
| hoverlabel
| plotly.graph_objs.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?
| ids
| Assigns id labels to 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 plot.ly 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_objs.violin.Line instance or dict with
| compatible properties
| marker
| plotly.graph_objs.violin.Marker instance or dict with
| compatible properties
| meanline
| plotly.graph_objs.violin.Meanline instance or dict with
| compatible properties
| 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
| 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
| 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.
| 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_objs.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_objs.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 plot.ly for text .
| uid
|
| unselected
| plotly.graph_objs.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).
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate of the box. 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 plot.ly for x .
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate of the box. 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 plot.ly 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`
|
| Returns
| -------
| Violin
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basewidget.BaseFigureWidget:
|
| on_edits_completed(self, fn)
| Register a function to be called after all pending trace and layout
| edit operations have completed
|
| If there are no pending edit operations then function is called
| immediately
|
| Parameters
| ----------
| fn : callable
| Function of zero arguments to be called when all pending edit
| operations have completed
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basewidget.BaseFigureWidget:
|
| frames
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFigure:
|
| __contains__(self, prop)
|
| __eq__(self, other)
|
| __getitem__(self, prop)
|
| __iter__(self)
|
| __repr__(self)
| Customize Figure representation when displayed in the
| terminal/notebook
|
| __setattr__(self, prop, value)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
| value
| New property value
| Returns
| -------
| None
|
| __setitem__(self, prop, value)
| # Magic Methods
| # -------------
|
| add_trace(self, trace, row=None, col=None)
| Add a trace to the figure
|
| Parameters
| ----------
| trace : BaseTraceType or dict
| Either:
| - An instances of a trace classe from the plotly.graph_objs
| package (e.g plotly.graph_objs.Scatter, plotly.graph_objs.Bar)
| - or a dicts where:
|
| - The 'type' property specifies the trace type (e.g.
| 'scatter', 'bar', 'area', etc.). If the dict has no 'type'
| property then 'scatter' is assumed.
| - All remaining properties are passed to the constructor
| of the specified trace type.
|
| row : 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
| -------
| BaseTraceType
| The newly added trace
|
| Examples
| --------
| >>> from plotly import tools
| >>> import plotly.graph_objs as go
|
| Add two Scatter traces to a figure
| >>> fig = go.Figure()
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]))
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]))
|
|
| Add two Scatter traces to vertically stacked subplots
| >>> fig = tools.make_subplots(rows=2)
| This is the format of your plot grid:
| [ (1,1) x1,y1 ]
| [ (2,1) x2,y2 ]
|
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1)
|
| add_traces(self, data, rows=None, cols=None)
| Add traces to the figure
|
| Parameters
| ----------
| data : list[BaseTraceType or dict]
| A list of trace specifications to be added.
| Trace specifications may be either:
|
| - Instances of trace classes from the plotly.graph_objs
| package (e.g plotly.graph_objs.Scatter, plotly.graph_objs.Bar)
| - Dicts where:
|
| - The 'type' property specifies the trace type (e.g.
| 'scatter', 'bar', 'area', etc.). If the dict has no 'type'
| property then 'scatter' is assumed.
| - All remaining properties are passed to the constructor
| of the specified trace type.
|
| rows : None or list[int] (default None)
| List of subplot row indexes (starting from 1) for the traces to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| cols : None or list[int] (default None)
| List of subplot column indexes (starting from 1) for the traces
| to be added. Only valid if figure was created using
| `plotly.tools.make_subplots`
|
| Returns
| -------
| tuple[BaseTraceType]
| Tuple of the newly added traces
|
| Examples
| --------
| >>> from plotly import tools
| >>> import plotly.graph_objs as go
|
| Add two Scatter traces to a figure
| >>> fig = go.Figure()
| >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
| ... go.Scatter(x=[1,2,3], y=[2,1,2])])
|
| Add two Scatter traces to vertically stacked subplots
| >>> fig = tools.make_subplots(rows=2)
| This is the format of your plot grid:
| [ (1,1) x1,y1 ]
| [ (2,1) x2,y2 ]
|
| >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
| ... go.Scatter(x=[1,2,3], y=[2,1,2])],
| ... rows=[1, 2], cols=[1, 1])
|
| append_trace(self, trace, row, col)
| Add a trace to the figure bound to axes at the specified row,
| col index.
|
| A row, col index grid is generated for figures created with
| plotly.tools.make_subplots, and can be viewed with the `print_grid`
| method
|
| Parameters
| ----------
| trace
| The data trace to be bound
| row: int
| Subplot row index (see Figure.print_grid)
| col: int
| Subplot column index (see Figure.print_grid)
|
| Examples
| --------
| >>> from plotly import tools
| >>> import plotly.graph_objs as go
| # stack two subplots vertically
| >>> fig = tools.make_subplots(rows=2)
| This is the format of your plot grid:
| [ (1,1) x1,y1 ]
| [ (2,1) x2,y2 ]
|
| >>> fig.append_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1)
| >>> fig.append_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1)
|
| batch_animate(*args, **kwds)
| Context manager to animate trace / layout updates
|
| Parameters
| ----------
| duration : number
| The duration of the transition, in milliseconds.
| If equal to zero, updates are synchronous.
| easing : string
| The easing function used for the transition.
| One of:
| - linear
| - quad
| - cubic
| - sin
| - exp
| - circle
| - elastic
| - back
| - bounce
| - linear-in
| - quad-in
| - cubic-in
| - sin-in
| - exp-in
| - circle-in
| - elastic-in
| - back-in
| - bounce-in
| - linear-out
| - quad-out
| - cubic-out
| - sin-out
| - exp-out
| - circle-out
| - elastic-out
| - back-out
| - bounce-out
| - linear-in-out
| - quad-in-out
| - cubic-in-out
| - sin-in-out
| - exp-in-out
| - circle-in-out
| - elastic-in-out
| - back-in-out
| - bounce-in-out
|
| Examples
| --------
| Suppose we have a figure widget, `fig`, with a single trace.
|
| >>> import plotly.graph_objs as go
| >>> fig = go.FigureWidget(data=[{'y': [3, 4, 2]}])
|
| 1) Animate a change in the xaxis and yaxis ranges using default
| duration and easing parameters.
|
| >>> with fig.batch_animate():
| ... fig.layout.xaxis.range = [0, 5]
| ... fig.layout.yaxis.range = [0, 10]
|
| 2) Animate a change in the size and color of the trace's markers
| over 2 seconds using the elastic-in-out easing method
| >>> with fig.batch_update(duration=2000, easing='elastic-in-out'):
| ... fig.data[0].marker.color = 'green'
| ... fig.data[0].marker.size = 20
|
| batch_update(*args, **kwds)
| A context manager that batches up trace and layout assignment
| operations into a singe plotly_update message that is executed when
| the context exits.
|
| Examples
| --------
| For example, suppose we have a figure widget, `fig`, with a single
| trace.
| >>> import plotly.graph_objs as go
| >>> fig = go.FigureWidget(data=[{'y': [3, 4, 2]}])
|
| If we want to update the xaxis range, the yaxis range, and the
| marker color, we could do so using a series of three property
| assignments as follows:
|
| >>> fig.layout.xaxis.range = [0, 5]
| >>> fig.layout.yaxis.range = [0, 10]
| >>> fig.data[0].marker.color = 'green'
|
| This will work, however it will result in three messages being
| sent to the front end (two relayout messages for the axis range
| updates followed by one restyle message for the marker color
| update). This can cause the plot to appear to stutter as the
| three updates are applied incrementally.
|
| We can avoid this problem by performing these three assignments in a
| `batch_update` context as follows:
|
| >>> with fig.batch_update():
| ... fig.layout.xaxis.range = [0, 5]
| ... fig.layout.yaxis.range = [0, 10]
| ... fig.data[0].marker.color = 'green'
|
| Now, these three property updates will be sent to the frontend in a
| single update message, and they will be applied by the front end
| simultaneously.
|
| plotly_relayout(self, relayout_data, **kwargs)
| Perform a Plotly relayout operation on the figure's layout
|
| Parameters
| ----------
| relayout_data : dict
| Dict of layout updates
|
| dict keys are strings that specify the properties to be updated.
| Nested properties are expressed by joining successive keys on
| '.' characters (e.g. 'xaxis.range')
|
| dict values are the values to use to update the layout.
|
| Returns
| -------
| None
|
| plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs)
| Perform a Plotly restyle operation on the figure's traces
|
| Parameters
| ----------
| restyle_data : dict
| Dict of trace style updates.
|
| Keys are strings that specify the properties to be updated.
| Nested properties are expressed by joining successive keys on
| '.' characters (e.g. 'marker.color').
|
| Values may be scalars or lists. When values are scalars,
| that scalar value is applied to all traces specified by the
| `trace_indexes` parameter. When values are lists,
| the restyle operation will cycle through the elements
| of the list as it cycles through the traces specified by the
| `trace_indexes` parameter.
|
| Caution: To use plotly_restyle to update a list property (e.g.
| the `x` property of the scatter trace), the property value
| should be a scalar list containing the list to update with. For
| example, the following command would be used to update the 'x'
| property of the first trace to the list [1, 2, 3]
|
| >>> fig.plotly_restyle({'x': [[1, 2, 3]]}, 0)
|
| trace_indexes : int or list of int
| Trace index, or list of trace indexes, that the restyle operation
| applies to. Defaults to all trace indexes.
|
| Returns
| -------
| None
|
| plotly_update(self, restyle_data=None, relayout_data=None, trace_indexes=None, **kwargs)
| Perform a Plotly update operation on the figure.
|
| Note: This operation both mutates and returns the figure
|
| Parameters
| ----------
| restyle_data : dict
| Traces update specification. See the docstring for the
| `plotly_restyle` method for details
| relayout_data : dict
| Layout update specification. See the docstring for the
| `plotly_relayout` method for details
| trace_indexes :
| Trace index, or list of trace indexes, that the update operation
| applies to. Defaults to all trace indexes.
|
| Returns
| -------
| BaseFigure
| None
|
| print_grid(self)
| Print a visual layout of the figure's axes arrangement.
| This is only valid for figures that are created
| with plotly.tools.make_subplots.
|
| to_dict(self)
| Convert figure to a dictionary
|
| Note: the dictionary includes the properties explicitly set by the
| user, it does not include default values of unspecified properties
|
| Returns
| -------
| dict
|
| to_plotly_json(self)
| Convert figure to a JSON representation as a Python dict
|
| Returns
| -------
| dict
|
| update(self, dict1=None, **kwargs)
| Update the properties of the figure with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the figure
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| kwargs :
| Keyword/value pair of properties to be updated
|
| Examples
| --------
| >>> import plotly.graph_objs as go
| >>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
| >>> fig.update(data=[{'y': [4, 5, 6]}])
| >>> fig.to_plotly_json()
| {'data': [{'type': 'scatter',
| 'uid': 'e86a7c7a-346a-11e8-8aa8-a0999b0c017b',
| 'y': array([4, 5, 6], dtype=int32)}],
| 'layout': {}}
|
| >>> fig = go.Figure(layout={'xaxis':
| ... {'color': 'green',
| ... 'range': [0, 1]}})
| >>> fig.update({'layout': {'xaxis': {'color': 'pink'}}})
| >>> fig.to_plotly_json()
| {'data': [],
| 'layout': {'xaxis':
| {'color': 'pink',
| 'range': [0, 1]}}}
|
| Returns
| -------
| BaseFigure
| Updated figure
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BaseFigure:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
|
| data
| The `data` property is a tuple of the figure's trace objects
|
| Returns
| -------
| tuple[BaseTraceType]
|
| layout
| The `layout` property of the figure
|
| Returns
| -------
| plotly.graph_objs.Layout
|
| ----------------------------------------------------------------------
| Methods inherited from ipywidgets.widgets.domwidget.DOMWidget:
|
| add_class(self, className)
| Adds a class to the top level element of the widget.
|
| Doesn't add the class if it already exists.
|
| remove_class(self, className)
| Removes a class from the top level element of the widget.
|
| Doesn't remove the class if it doesn't exist.
|
| ----------------------------------------------------------------------
| Methods inherited from ipywidgets.widgets.widget.Widget:
|
| __del__(self)
| Object disposal
|
| add_traits(self, **traits)
| Dynamically add trait attributes to the Widget.
|
| close(self)
| Close method.
|
| Closes the underlying comm.
| When the comm is closed, all of the widget views are automatically
| removed from the front-end.
|
| get_state(self, key=None, drop_defaults=False)
| Gets the widget state, or a piece of it.
|
| Parameters
| ----------
| key : unicode or iterable (optional)
| A single property's name or iterable of property names to get.
|
| Returns
| -------
| state : dict of states
| metadata : dict
| metadata for each field: {key: metadata}
|
| get_view_spec(self)
|
| hold_sync(*args, **kwds)
| Hold syncing any state until the outermost context manager exits
|
| notify_change(self, change)
| Called when a property has changed.
|
| on_displayed(self, callback, remove=False)
| (Un)Register a widget displayed callback.
|
| Parameters
| ----------
| callback: method handler
| Must have a signature of::
|
| callback(widget, **kwargs)
|
| kwargs from display are passed through without modification.
| remove: bool
| True if the callback should be unregistered.
|
| on_msg(self, callback, remove=False)
| (Un)Register a custom msg receive callback.
|
| Parameters
| ----------
| callback: callable
| callback will be passed three arguments when a message arrives::
|
| callback(widget, content, buffers)
|
| remove: bool
| True if the callback should be unregistered.
|
| open(self)
| Open a comm to the frontend if one isn't already open.
|
| send(self, content, buffers=None)
| Sends a custom msg to the widget model in the front-end.
|
| Parameters
| ----------
| content : dict
| Content of the message to send.
| buffers : list of binary buffers
| Binary buffers to send with message
|
| send_state(self, key=None)
| Sends the widget state, or a piece of it, to the front-end, if it exists.
|
| Parameters
| ----------
| key : unicode, or iterable (optional)
| A single property's name or iterable of property names to sync with the front-end.
|
| set_state(self, sync_data)
| Called when a state is received from the front-end.
|
| ----------------------------------------------------------------------
| Class methods inherited from ipywidgets.widgets.widget.Widget:
|
| close_all(cls) from traitlets.traitlets.MetaHasTraits
|
| ----------------------------------------------------------------------
| Static methods inherited from ipywidgets.widgets.widget.Widget:
|
| get_manager_state(drop_defaults=False, widgets=None)
| Returns the full state for a widget manager for embedding
|
| :param drop_defaults: when True, it will not include default value
| :param widgets: list with widgets to include in the state (or all widgets when None)
| :return:
|
| handle_comm_opened(comm, msg)
| Static method, called when a widget is constructed.
|
| on_widget_constructed(callback)
| Registers a callback to be called when a widget is constructed.
|
| The callback must have the following signature:
| callback(widget)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.widget.Widget:
|
| comm
| A trait whose value must be an instance of a specified class.
|
| The value can also be an instance of a subclass of the specified class.
|
| Subclasses can declare default classes by overriding the klass attribute
|
| keys
| An instance of a Python list.
|
| model_id
| Gets the model id of this widget.
|
| If a Comm doesn't exist yet, a Comm will be created automagically.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from ipywidgets.widgets.widget.Widget:
|
| widget_types = <ipywidgets.widgets.widget.WidgetRegistry object>
|
| widgets = {u'063d9336bd344e3cbba3d489abca29ce': FigureWidget({
| 'da...
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.widget.LoggingHasTraits:
|
| log
| A trait whose value must be an instance of a specified class.
|
| The value can also be an instance of a subclass of the specified class.
|
| Subclasses can declare default classes by overriding the klass attribute
|
| ----------------------------------------------------------------------
| Methods inherited from traitlets.traitlets.HasTraits:
|
| __getstate__(self)
|
| __setstate__(self, state)
|
| has_trait(self, name)
| Returns True if the object has a trait with the specified name.
|
| hold_trait_notifications(*args, **kwds)
| Context manager for bundling trait change notifications and cross
| validation.
|
| Use this when doing multiple trait assignments (init, config), to avoid
| race conditions in trait notifiers requesting other trait values.
| All trait notifications will fire after all values have been assigned.
|
| observe(self, handler, names=traitlets.All, type='change')
| Setup a handler to be called when a trait changes.
|
| This is used to setup dynamic notifications of trait changes.
|
| Parameters
| ----------
| handler : callable
| A callable that is called when a trait changes. Its
| signature should be ``handler(change)``, where ``change`` is a
| dictionary. The change dictionary at least holds a 'type' key.
| * ``type``: the type of notification.
| Other keys may be passed depending on the value of 'type'. In the
| case where type is 'change', we also have the following keys:
| * ``owner`` : the HasTraits instance
| * ``old`` : the old value of the modified trait attribute
| * ``new`` : the new value of the modified trait attribute
| * ``name`` : the name of the modified trait attribute.
| names : list, str, All
| If names is All, the handler will apply to all traits. If a list
| of str, handler will apply to all names in the list. If a
| str, the handler will apply just to that name.
| type : str, All (default: 'change')
| The type of notification to filter by. If equal to All, then all
| notifications are passed to the observe handler.
|
| on_trait_change(self, handler=None, name=None, remove=False)
| DEPRECATED: Setup a handler to be called when a trait changes.
|
| This is used to setup dynamic notifications of trait changes.
|
| Static handlers can be created by creating methods on a HasTraits
| subclass with the naming convention '_[traitname]_changed'. Thus,
| to create static handler for the trait 'a', create the method
| _a_changed(self, name, old, new) (fewer arguments can be used, see
| below).
|
| If `remove` is True and `handler` is not specified, all change
| handlers for the specified name are uninstalled.
|
| Parameters
| ----------
| handler : callable, None
| A callable that is called when a trait changes. Its
| signature can be handler(), handler(name), handler(name, new),
| handler(name, old, new), or handler(name, old, new, self).
| name : list, str, None
| If None, the handler will apply to all traits. If a list
| of str, handler will apply to all names in the list. If a
| str, the handler will apply just to that name.
| remove : bool
| If False (the default), then install the handler. If True
| then unintall it.
|
| set_trait(self, name, value)
| Forcibly sets trait attribute, including read-only attributes.
|
| setup_instance(self, *args, **kwargs)
|
| trait_metadata(self, traitname, key, default=None)
| Get metadata values for trait by key.
|
| trait_names(self, **metadata)
| Get a list of all the names of this class' traits.
|
| traits(self, **metadata)
| Get a ``dict`` of all the traits of this class. The dictionary
| is keyed on the name and the values are the TraitType objects.
|
| The TraitTypes returned don't know anything about the values
| that the various HasTrait's instances are holding.
|
| The metadata kwargs allow functions to be passed in which
| filter traits based on metadata values. The functions should
| take a single value as an argument and return a boolean. If
| any function returns False, then the trait is not included in
| the output. If a metadata key doesn't exist, None will be passed
| to the function.
|
| unobserve(self, handler, names=traitlets.All, type='change')
| Remove a trait change handler.
|
| This is used to unregister handlers to trait change notifications.
|
| Parameters
| ----------
| handler : callable
| The callable called when a trait attribute changes.
| names : list, str, All (default: All)
| The names of the traits for which the specified handler should be
| uninstalled. If names is All, the specified handler is uninstalled
| from the list of notifiers corresponding to all changes.
| type : str or All (default: 'change')
| The type of notification to filter by. If All, the specified handler
| is uninstalled from the list of notifiers corresponding to all types.
|
| unobserve_all(self, name=traitlets.All)
| Remove trait change handlers of any type for the specified name.
| If name is not specified, removes all trait notifiers.
|
| ----------------------------------------------------------------------
| Class methods inherited from traitlets.traitlets.HasTraits:
|
| class_own_trait_events(cls, name) from traitlets.traitlets.MetaHasTraits
| Get a dict of all event handlers defined on this class, not a parent.
|
| Works like ``event_handlers``, except for excluding traits from parents.
|
| class_own_traits(cls, **metadata) from traitlets.traitlets.MetaHasTraits
| Get a dict of all the traitlets defined on this class, not a parent.
|
| Works like `class_traits`, except for excluding traits from parents.
|
| class_trait_names(cls, **metadata) from traitlets.traitlets.MetaHasTraits
| Get a list of all the names of this class' traits.
|
| This method is just like the :meth:`trait_names` method,
| but is unbound.
|
| class_traits(cls, **metadata) from traitlets.traitlets.MetaHasTraits
| Get a ``dict`` of all the traits of this class. The dictionary
| is keyed on the name and the values are the TraitType objects.
|
| This method is just like the :meth:`traits` method, but is unbound.
|
| The TraitTypes returned don't know anything about the values
| that the various HasTrait's instances are holding.
|
| The metadata kwargs allow functions to be passed in which
| filter traits based on metadata values. The functions should
| take a single value as an argument and return a boolean. If
| any function returns False, then the trait is not included in
| the output. If a metadata key doesn't exist, None will be passed
| to the function.
|
| trait_events(cls, name=None) from traitlets.traitlets.MetaHasTraits
| Get a ``dict`` of all the event handlers of this class.
|
| Parameters
| ----------
| name: str (default: None)
| The name of a trait of this class. If name is ``None`` then all
| the event handlers of this class will be returned instead.
|
| Returns
| -------
| The event handlers associated with a trait name, or all event handlers.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from traitlets.traitlets.HasTraits:
|
| cross_validation_lock
| A contextmanager for running a block with our cross validation lock set
| to True.
|
| At the end of the block, the lock's value is restored to its value
| prior to entering the block.
|
| ----------------------------------------------------------------------
| Static methods inherited from traitlets.traitlets.HasDescriptors:
|
| __new__(cls, *args, **kwargs)
